Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: VL6180_Board
API Register access functions
[API Low Level Functions]
Registers access functions called by API core functions. More...
Functions | |
| VL6180_API int | VL6180_WrByte (VL6180Dev_t dev, uint16_t index, uint8_t data) |
| Write VL6180 single byte register. | |
| VL6180_API int | VL6180_UpdateByte (VL6180Dev_t dev, uint16_t index, uint8_t AndData, uint8_t OrData) |
| Thread safe VL6180 Update (rd/modify/write) single byte register. | |
| VL6180_API int | VL6180_WrWord (VL6180Dev_t dev, uint16_t index, uint16_t data) |
| Write VL6180 word register. | |
| VL6180_API int | VL6180_WrDWord (VL6180Dev_t dev, uint16_t index, uint32_t data) |
| Write VL6180 double word (4 byte) register. | |
| VL6180_API int | VL6180_RdByte (VL6180Dev_t dev, uint16_t index, uint8_t *data) |
| Read VL6180 single byte register. | |
| VL6180_API int | VL6180_RdWord (VL6180Dev_t dev, uint16_t index, uint16_t *data) |
| Read VL6180 word (2byte) register. | |
| VL6180_API int | VL6180_RdDWord (VL6180Dev_t dev, uint16_t index, uint32_t *data) |
| Read VL6180 dword (4byte) register. | |
| VL6180_API int | VL6180_RdMulti (VL6180Dev_t dev, uint16_t index, uint8_t *data, int nData) |
| Read VL6180 multiple bytes. | |
Detailed Description
Registers access functions called by API core functions.
Function Documentation
| VL6180_API int VL6180_RdByte | ( | VL6180Dev_t | dev, |
| uint16_t | index, | ||
| uint8_t * | data | ||
| ) |
Read VL6180 single byte register.
- Parameters:
-
dev The device index The register index data pointer to 8 bit data
- Returns:
- 0 on success
Definition at line 212 of file vl6180_i2c_fn.c.
| VL6180_API int VL6180_RdDWord | ( | VL6180Dev_t | dev, |
| uint16_t | index, | ||
| uint32_t * | data | ||
| ) |
Read VL6180 dword (4byte) register.
- Parameters:
-
dev The device index The register index data pointer to 32 bit data
- Returns:
- 0 on success
Definition at line 292 of file vl6180_i2c_fn.c.
| VL6180_API int VL6180_RdMulti | ( | VL6180Dev_t | dev, |
| uint16_t | index, | ||
| uint8_t * | data, | ||
| int | nData | ||
| ) |
Read VL6180 multiple bytes.
- Note:
- required only if VL6180_HAVE_MULTI_READ is set
- Parameters:
-
dev The device index The register index data pointer to 8 bit data nData number of data bytes to read
- Returns:
- 0 on success
Definition at line 332 of file vl6180_i2c_fn.c.
| VL6180_API int VL6180_RdWord | ( | VL6180Dev_t | dev, |
| uint16_t | index, | ||
| uint16_t * | data | ||
| ) |
Read VL6180 word (2byte) register.
- Parameters:
-
dev The device index The register index data pointer to 16 bit data
- Returns:
- 0 on success
Definition at line 250 of file vl6180_i2c_fn.c.
| VL6180_API int VL6180_UpdateByte | ( | VL6180Dev_t | dev, |
| uint16_t | index, | ||
| uint8_t | AndData, | ||
| uint8_t | OrData | ||
| ) |
Thread safe VL6180 Update (rd/modify/write) single byte register.
Final_reg = (Initial_reg & and_data) |or_data
- Parameters:
-
dev The device index The register index AndData 8 bit and data OrData 8 bit or data
- Returns:
- 0 on success
Definition at line 166 of file vl6180_i2c_fn.c.
| VL6180_API int VL6180_WrByte | ( | VL6180Dev_t | dev, |
| uint16_t | index, | ||
| uint8_t | data | ||
| ) |
Write VL6180 single byte register.
- Parameters:
-
dev The device index The register index data 8 bit register data
- Returns:
- success
Definition at line 67 of file vl6180_i2c_fn.c.
| VL6180_API int VL6180_WrDWord | ( | VL6180Dev_t | dev, |
| uint16_t | index, | ||
| uint32_t | data | ||
| ) |
Write VL6180 double word (4 byte) register.
- Parameters:
-
dev The device index The register index data 32 bit register data
- Returns:
- 0 on success
Definition at line 129 of file vl6180_i2c_fn.c.
| VL6180_API int VL6180_WrWord | ( | VL6180Dev_t | dev, |
| uint16_t | index, | ||
| uint16_t | data | ||
| ) |
Write VL6180 word register.
- Parameters:
-
dev The device index The register index data 16 bit register data
- Returns:
- 0 on success
Definition at line 95 of file vl6180_i2c_fn.c.
Generated on Tue Nov 29 2022 20:47:36 by
1.7.2