Define the meaning of 'type' for BusIO Registers
jayjlawrence opened this issue · 3 comments
Not an issue but hopefully helpful input. I didn't know where best to put this info so am providing here. I struggled a bit over what "type" meant when defining a Adafruit_BusIO_Register and then it clicked once I saw the code. To assist future developers here is an attempt at a couple of definitions:
ADDRBIT8_HIGH_TOREAD When reading a register you must actually send the value 0x80 + register to the device. e.g. To read the register 0x0B the register value 0x8B is sent and to write 0x0B is sent.
ADDRBIT8_HIGH_TOWRITE When writing to a register you must actually send the value 0x80 + register to the device. e.g. To write to the register 0x19 the register value 0x99 is sent and to read 0x19 is sent.
Hope this helps. Also can the documentation be generated and included in the git repository?
yep! if you'd like to add that text to the register consts, and PR it here to this repo - it will automatically get doxygen'd by Actions and put here:
https://adafruit.github.io/Adafruit_BusIO/html/annotated.html
@jayjlawrence Did #41 fix this?
Closing due to lack of response. Seems fixed.