Define the meaning of 'type' for BusIO Registers

Addressed issue #19 by updating register consts with suggested descriptions.

Co-Authored-By: jayjlawrence <1862335+jayjlawrence@users.noreply.github.com>
This commit is contained in:
Stuart Feichtinger 2021-01-20 16:47:39 -06:00
parent bb1ad733ad
commit 2f80a5e646
1 changed files with 13 additions and 0 deletions

View File

@ -7,8 +7,21 @@
typedef enum _Adafruit_BusIO_SPIRegType {
ADDRBIT8_HIGH_TOREAD = 0,
/*!<
* ADDRBIT8_HIGH_TOREAD
* When reading a register you must actually send the value 0x80 + register
* address to the device. e.g. To read the register 0x0B the register value
* 0x8B is sent and to write 0x0B is sent.
*/
AD8_HIGH_TOREAD_AD7_HIGH_TOINC = 1,
ADDRBIT8_HIGH_TOWRITE = 2,
/*!<
* ADDRBIT8_HIGH_TOWRITE
* When writing to a register you must actually send the value 0x80 +
* the register address to the device. e.g. To write to the register 0x19 the
* register value 0x99 is sent and to read 0x19 is sent.
*/
} Adafruit_BusIO_SPIRegType;
/*!