VL53L1 Register Function declarations. More...

#include "vl53l1_platform.h"

Include dependency graph for vl53l1_register_funcs.h:

This graph shows which files directly or indirectly include this file:

Functions
VL53L1_Error	VL53L1_get_customer_nvm_managed (VL53L1_DEV Dev, VL53L1_customer_nvm_managed_t *pdata)
	Gets customer_nvm_managed register group. More...

VL53L1_Error	VL53L1_get_nvm_copy_data (VL53L1_DEV Dev, VL53L1_nvm_copy_data_t *pdata)
	Sets nvm_copy_data register group. More...

VL53L1_Error	VL53L1_get_static_nvm_managed (VL53L1_DEV Dev, VL53L1_static_nvm_managed_t *pdata)
	Gets static_nvm_managed register group. More...

VL53L1_Error	VL53L1_get_system_results (VL53L1_DEV Dev, VL53L1_system_results_t *pdata)
	Sets system_results register group. More...

VL53L1_Error	VL53L1_i2c_decode_core_results (uint16_t buf_size, uint8_t pbuffer, VL53L1_core_results_t pdata)
	Encodes data structure VL53L1_core_results_t into a I2C write buffer. More...

VL53L1_Error	VL53L1_i2c_decode_customer_nvm_managed (uint16_t buf_size, uint8_t pbuffer, VL53L1_customer_nvm_managed_t pdata)
	Decodes data structure VL53L1_customer_nvm_managed_t from the input I2C read buffer. More...

VL53L1_Error	VL53L1_i2c_decode_debug_results (uint16_t buf_size, uint8_t pbuffer, VL53L1_debug_results_t pdata)
	Sets core_results register group. More...

VL53L1_Error	VL53L1_i2c_decode_general_config (uint16_t buf_size, uint8_t pbuffer, VL53L1_general_config_t pdata)
	Decodes data structure VL53L1_general_config_t from the input I2C read buffer. More...

VL53L1_Error	VL53L1_i2c_decode_nvm_copy_data (uint16_t buf_size, uint8_t pbuffer, VL53L1_nvm_copy_data_t pdata)
	Sets debug_results register group. More...

VL53L1_Error	VL53L1_i2c_decode_static_config (uint16_t buf_size, uint8_t pbuffer, VL53L1_static_config_t pdata)
	Decodes data structure VL53L1_static_config_t from the input I2C read buffer. More...

VL53L1_Error	VL53L1_i2c_decode_static_nvm_managed (uint16_t buf_size, uint8_t pbuffer, VL53L1_static_nvm_managed_t pdata)
	Decodes data structure VL53L1_static_nvm_managed_t from the input I2C read buffer. More...

VL53L1_Error	VL53L1_i2c_decode_system_results (uint16_t buf_size, uint8_t pbuffer, VL53L1_system_results_t pdata)
	Gets system_control register group. More...

VL53L1_Error	VL53L1_i2c_encode_customer_nvm_managed (VL53L1_customer_nvm_managed_t pdata, uint16_t buf_size, uint8_t pbuffer)
	Encodes data structure VL53L1_customer_nvm_managed_t into a I2C write buffer. More...

VL53L1_Error	VL53L1_i2c_encode_dynamic_config (VL53L1_dynamic_config_t pdata, uint16_t buf_size, uint8_t pbuffer)
	Decodes data structure VL53L1_timing_config_t from the input I2C read buffer. More...

VL53L1_Error	VL53L1_i2c_encode_general_config (VL53L1_general_config_t pdata, uint16_t buf_size, uint8_t pbuffer)
	Gets static_config register group. More...

VL53L1_Error	VL53L1_i2c_encode_static_config (VL53L1_static_config_t pdata, uint16_t buf_size, uint8_t pbuffer)
	Encodes data structure VL53L1_static_config_t into a I2C write buffer. More...

VL53L1_Error	VL53L1_i2c_encode_static_nvm_managed (VL53L1_static_nvm_managed_t pdata, uint16_t buf_size, uint8_t pbuffer)
	Encodes data structure VL53L1_static_nvm_managed_t into a I2C write buffer. More...

VL53L1_Error	VL53L1_i2c_encode_system_control (VL53L1_system_control_t pdata, uint16_t buf_size, uint8_t pbuffer)
	Gets dynamic_config register group. More...

VL53L1_Error	VL53L1_i2c_encode_timing_config (VL53L1_timing_config_t pdata, uint16_t buf_size, uint8_t pbuffer)
	Gets general_config register group. More...

VL53L1_Error	VL53L1_set_customer_nvm_managed (VL53L1_DEV Dev, VL53L1_customer_nvm_managed_t *pdata)
	Sets customer_nvm_managed register group. More...

VL53L1_Error	VL53L1_set_dynamic_config (VL53L1_DEV Dev, VL53L1_dynamic_config_t *pdata)
	Decodes data structure VL53L1_dynamic_config_t from the input I2C read buffer. More...

VL53L1_Error	VL53L1_set_general_config (VL53L1_DEV Dev, VL53L1_general_config_t *pdata)
	Sets general_config register group. More...

VL53L1_Error	VL53L1_set_static_config (VL53L1_DEV Dev, VL53L1_static_config_t *pdata)
	Sets static_config register group. More...

VL53L1_Error	VL53L1_set_static_nvm_managed (VL53L1_DEV Dev, VL53L1_static_nvm_managed_t *pdata)
	Sets static_nvm_managed register group. More...

VL53L1_Error	VL53L1_set_system_control (VL53L1_DEV Dev, VL53L1_system_control_t *pdata)
	Decodes data structure VL53L1_system_control_t from the input I2C read buffer. More...

Detailed Description

VL53L1 Register Function declarations.

Definition in file vl53l1_register_funcs.h.

Function Documentation

◆ VL53L1_get_customer_nvm_managed()

VL53L1_Error VL53L1_get_customer_nvm_managed	(	VL53L1_DEV	Dev,
		VL53L1_customer_nvm_managed_t *	pdata
	)

Gets customer_nvm_managed register group.

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_customer_nvm_managed_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_customer_nvm_managed_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Reads and de-serialises the contents of VL53L1_customer_nvm_managed_t data structure from the device

Definition at line 399 of file vl53l1_register_funcs.c.

◆ VL53L1_get_nvm_copy_data()

VL53L1_Error VL53L1_get_nvm_copy_data	(	VL53L1_DEV	Dev,
		VL53L1_nvm_copy_data_t *	pdata
	)

Sets nvm_copy_data register group.

Serailises (encodes) VL53L1_nvm_copy_data_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_nvm_copy_data_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Gets nvm_copy_data register group

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_nvm_copy_data_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_nvm_copy_data_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Reads and de-serialises the contents of VL53L1_nvm_copy_data_t data structure from the device

Definition at line 2405 of file vl53l1_register_funcs.c.

◆ VL53L1_get_static_nvm_managed()

VL53L1_Error VL53L1_get_static_nvm_managed	(	VL53L1_DEV	Dev,
		VL53L1_static_nvm_managed_t *	pdata
	)

Gets static_nvm_managed register group.

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_static_nvm_managed_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_static_nvm_managed_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Reads and de-serialises the contents of VL53L1_static_nvm_managed_t data structure from the device

Definition at line 207 of file vl53l1_register_funcs.c.

◆ VL53L1_get_system_results()

VL53L1_Error VL53L1_get_system_results	(	VL53L1_DEV	Dev,
		VL53L1_system_results_t *	pdata
	)

Sets system_results register group.

Serailises (encodes) VL53L1_system_results_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_system_results_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Gets system_results register group

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_system_results_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_system_results_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Reads and de-serialises the contents of VL53L1_system_results_t data structure from the device

Definition at line 1600 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_decode_core_results()

VL53L1_Error VL53L1_i2c_decode_core_results	(	uint16_t	buf_size,
		uint8_t *	pbuffer,
		VL53L1_core_results_t *	pdata
	)

Encodes data structure VL53L1_core_results_t into a I2C write buffer.

Buffer must be at least 33 bytes

Parameters

[in]	pdata	: pointer to VL53L1_core_results_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Decodes data structure VL53L1_core_results_t from the input I2C read buffer

Buffer must be at least 33 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_core_results_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Decodes data structure VL53L1_core_results_t from the input I2C read buffer Buffer must be at least 33 bytes

Definition at line 1693 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_decode_customer_nvm_managed()

VL53L1_Error VL53L1_i2c_decode_customer_nvm_managed	(	uint16_t	buf_size,
		uint8_t *	pbuffer,
		VL53L1_customer_nvm_managed_t *	pdata
	)

Decodes data structure VL53L1_customer_nvm_managed_t from the input I2C read buffer.

Buffer must be at least 23 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_customer_nvm_managed_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Decodes data structure VL53L1_customer_nvm_managed_t from the input I2C read buffer Buffer must be at least 23 bytes

Definition at line 310 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_decode_debug_results()

VL53L1_Error VL53L1_i2c_decode_debug_results	(	uint16_t	buf_size,
		uint8_t *	pbuffer,
		VL53L1_debug_results_t *	pdata
	)

Sets core_results register group.

Serailises (encodes) VL53L1_core_results_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_core_results_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Gets core_results register group

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_core_results_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_core_results_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Encodes data structure VL53L1_debug_results_t into a I2C write buffer

Buffer must be at least 56 bytes

Parameters

[in]	pdata	: pointer to VL53L1_debug_results_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Decodes data structure VL53L1_debug_results_t from the input I2C read buffer

Buffer must be at least 56 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_debug_results_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Decodes data structure VL53L1_debug_results_t from the input I2C read buffer Buffer must be at least 56 bytes

Definition at line 1937 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_decode_general_config()

VL53L1_Error VL53L1_i2c_decode_general_config	(	uint16_t	buf_size,
		uint8_t *	pbuffer,
		VL53L1_general_config_t *	pdata
	)

Decodes data structure VL53L1_general_config_t from the input I2C read buffer.

Buffer must be at least 22 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_general_config_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Decodes data structure VL53L1_general_config_t from the input I2C read buffer Buffer must be at least 22 bytes

Definition at line 738 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_decode_nvm_copy_data()

VL53L1_Error VL53L1_i2c_decode_nvm_copy_data	(	uint16_t	buf_size,
		uint8_t *	pbuffer,
		VL53L1_nvm_copy_data_t *	pdata
	)

Sets debug_results register group.

Serailises (encodes) VL53L1_debug_results_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_debug_results_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Encodes data structure VL53L1_nvm_copy_data_t into a I2C write buffer

Buffer must be at least 49 bytes

Parameters

[in]	pdata	: pointer to VL53L1_nvm_copy_data_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Decodes data structure VL53L1_nvm_copy_data_t from the input I2C read buffer

Buffer must be at least 49 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_nvm_copy_data_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Decodes data structure VL53L1_nvm_copy_data_t from the input I2C read buffer Buffer must be at least 49 bytes

Definition at line 2245 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_decode_static_config()

VL53L1_Error VL53L1_i2c_decode_static_config	(	uint16_t	buf_size,
		uint8_t *	pbuffer,
		VL53L1_static_config_t *	pdata
	)

Decodes data structure VL53L1_static_config_t from the input I2C read buffer.

Buffer must be at least 32 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_static_config_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Decodes data structure VL53L1_static_config_t from the input I2C read buffer Buffer must be at least 32 bytes

Definition at line 520 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_decode_static_nvm_managed()

VL53L1_Error VL53L1_i2c_decode_static_nvm_managed	(	uint16_t	buf_size,
		uint8_t *	pbuffer,
		VL53L1_static_nvm_managed_t *	pdata
	)

Decodes data structure VL53L1_static_nvm_managed_t from the input I2C read buffer.

Buffer must be at least 11 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_static_nvm_managed_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Decodes data structure VL53L1_static_nvm_managed_t from the input I2C read buffer Buffer must be at least 11 bytes

Definition at line 130 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_decode_system_results()

VL53L1_Error VL53L1_i2c_decode_system_results	(	uint16_t	buf_size,
		uint8_t *	pbuffer,
		VL53L1_system_results_t *	pdata
	)

Gets system_control register group.

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_system_control_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_system_control_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Encodes data structure VL53L1_system_results_t into a I2C write buffer

Buffer must be at least 44 bytes

Parameters

[in]	pdata	: pointer to VL53L1_system_results_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Decodes data structure VL53L1_system_results_t from the input I2C read buffer

Buffer must be at least 44 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_system_results_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Decodes data structure VL53L1_system_results_t from the input I2C read buffer Buffer must be at least 44 bytes

Definition at line 1491 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_encode_customer_nvm_managed()

VL53L1_Error VL53L1_i2c_encode_customer_nvm_managed	(	VL53L1_customer_nvm_managed_t *	pdata,
		uint16_t	buf_size,
		uint8_t *	pbuffer
	)

Encodes data structure VL53L1_customer_nvm_managed_t into a I2C write buffer.

Buffer must be at least 23 bytes

Parameters

[in]	pdata	: pointer to VL53L1_customer_nvm_managed_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Encodes data structure VL53L1_customer_nvm_managed_t into a I2C write buffer Buffer must be at least 23 bytes

Definition at line 240 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_encode_dynamic_config()

VL53L1_Error VL53L1_i2c_encode_dynamic_config	(	VL53L1_dynamic_config_t *	pdata,
		uint16_t	buf_size,
		uint8_t *	pbuffer
	)

Decodes data structure VL53L1_timing_config_t from the input I2C read buffer.

Buffer must be at least 23 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_timing_config_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Sets timing_config register group

Serailises (encodes) VL53L1_timing_config_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_timing_config_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Gets timing_config register group

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_timing_config_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_timing_config_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Encodes data structure VL53L1_dynamic_config_t into a I2C write buffer

Buffer must be at least 18 bytes

Parameters

[in]	pdata	: pointer to VL53L1_dynamic_config_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Encodes data structure VL53L1_dynamic_config_t into a I2C write buffer Buffer must be at least 18 bytes

Definition at line 1054 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_encode_general_config()

VL53L1_Error VL53L1_i2c_encode_general_config	(	VL53L1_general_config_t *	pdata,
		uint16_t	buf_size,
		uint8_t *	pbuffer
	)

Gets static_config register group.

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_static_config_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_static_config_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Encodes data structure VL53L1_general_config_t into a I2C write buffer

Buffer must be at least 22 bytes

Parameters

[in]	pdata	: pointer to VL53L1_general_config_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Encodes data structure VL53L1_general_config_t into a I2C write buffer Buffer must be at least 22 bytes

Definition at line 672 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_encode_static_config()

VL53L1_Error VL53L1_i2c_encode_static_config	(	VL53L1_static_config_t *	pdata,
		uint16_t	buf_size,
		uint8_t *	pbuffer
	)

Encodes data structure VL53L1_static_config_t into a I2C write buffer.

Buffer must be at least 32 bytes

Parameters

[in]	pdata	: pointer to VL53L1_static_config_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Encodes data structure VL53L1_static_config_t into a I2C write buffer Buffer must be at least 32 bytes

Definition at line 432 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_encode_static_nvm_managed()

VL53L1_Error VL53L1_i2c_encode_static_nvm_managed	(	VL53L1_static_nvm_managed_t *	pdata,
		uint16_t	buf_size,
		uint8_t *	pbuffer
	)

Encodes data structure VL53L1_static_nvm_managed_t into a I2C write buffer.

Buffer must be at least 11 bytes

Parameters

[in]	pdata	: pointer to VL53L1_static_nvm_managed_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Encodes data structure VL53L1_static_nvm_managed_t into a I2C write buffer Buffer must be at least 11 bytes

Definition at line 84 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_encode_system_control()

VL53L1_Error VL53L1_i2c_encode_system_control	(	VL53L1_system_control_t *	pdata,
		uint16_t	buf_size,
		uint8_t *	pbuffer
	)

Gets dynamic_config register group.

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_dynamic_config_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_dynamic_config_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Encodes data structure VL53L1_system_control_t into a I2C write buffer

Buffer must be at least 5 bytes

Parameters

[in]	pdata	: pointer to VL53L1_system_control_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Encodes data structure VL53L1_system_control_t into a I2C write buffer Buffer must be at least 5 bytes

Definition at line 1239 of file vl53l1_register_funcs.c.

◆ VL53L1_i2c_encode_timing_config()

VL53L1_Error VL53L1_i2c_encode_timing_config	(	VL53L1_timing_config_t *	pdata,
		uint16_t	buf_size,
		uint8_t *	pbuffer
	)

Gets general_config register group.

Reads register info from the device via a multi byte I2C read transaction and deserialises (decodes) the data into the VL53L1_general_config_t structure

Parameters

[in]	Dev	: device handle
[out]	pdata	: pointer to VL53L1_general_config_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Encodes data structure VL53L1_timing_config_t into a I2C write buffer

Buffer must be at least 23 bytes

Parameters

[in]	pdata	: pointer to VL53L1_timing_config_t data structure
[in]	buf_size	: size of input buffer
[out]	pbuffer	: uint8_t buffer to write serialised data into (I2C Write Buffer)

Encodes data structure VL53L1_timing_config_t into a I2C write buffer Buffer must be at least 23 bytes

Definition at line 864 of file vl53l1_register_funcs.c.

◆ VL53L1_set_customer_nvm_managed()

VL53L1_Error VL53L1_set_customer_nvm_managed	(	VL53L1_DEV	Dev,
		VL53L1_customer_nvm_managed_t *	pdata
	)

Sets customer_nvm_managed register group.

Serailises (encodes) VL53L1_customer_nvm_managed_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_customer_nvm_managed_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Serialises and sends the contents of VL53L1_customer_nvm_managed_t data structure to the device

Definition at line 366 of file vl53l1_register_funcs.c.

◆ VL53L1_set_dynamic_config()

VL53L1_Error VL53L1_set_dynamic_config	(	VL53L1_DEV	Dev,
		VL53L1_dynamic_config_t *	pdata
	)

Decodes data structure VL53L1_dynamic_config_t from the input I2C read buffer.

Buffer must be at least 18 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_dynamic_config_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Sets dynamic_config register group

Serailises (encodes) VL53L1_dynamic_config_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_dynamic_config_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Serialises and sends the contents of VL53L1_dynamic_config_t data structure to the device

Definition at line 1171 of file vl53l1_register_funcs.c.

◆ VL53L1_set_general_config()

VL53L1_Error VL53L1_set_general_config	(	VL53L1_DEV	Dev,
		VL53L1_general_config_t *	pdata
	)

Sets general_config register group.

Serailises (encodes) VL53L1_general_config_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_general_config_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Serialises and sends the contents of VL53L1_general_config_t data structure to the device

Definition at line 796 of file vl53l1_register_funcs.c.

◆ VL53L1_set_static_config()

VL53L1_Error VL53L1_set_static_config	(	VL53L1_DEV	Dev,
		VL53L1_static_config_t *	pdata
	)

Sets static_config register group.

Serailises (encodes) VL53L1_static_config_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_static_config_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Serialises and sends the contents of VL53L1_static_config_t data structure to the device

Definition at line 604 of file vl53l1_register_funcs.c.

◆ VL53L1_set_static_nvm_managed()

VL53L1_Error VL53L1_set_static_nvm_managed	(	VL53L1_DEV	Dev,
		VL53L1_static_nvm_managed_t *	pdata
	)

Sets static_nvm_managed register group.

Serailises (encodes) VL53L1_static_nvm_managed_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_static_nvm_managed_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Serialises and sends the contents of VL53L1_static_nvm_managed_t data structure to the device

Definition at line 174 of file vl53l1_register_funcs.c.

◆ VL53L1_set_system_control()

VL53L1_Error VL53L1_set_system_control	(	VL53L1_DEV	Dev,
		VL53L1_system_control_t *	pdata
	)

Decodes data structure VL53L1_system_control_t from the input I2C read buffer.

Buffer must be at least 5 bytes

Parameters

[in]	buf_size	: size of input buffer
[in]	pbuffer	: uint8_t buffer contain input serialised data (I2C read buffer)
[out]	pdata	: pointer to VL53L1_system_control_t data structure

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Sets system_control register group

Serailises (encodes) VL53L1_system_control_t structure into a I2C write data buffer and sends the buffer to the device via a multi byte I2C write transaction

Parameters

[in]	Dev	: device handle
[in]	pdata	: pointer to VL53L1_system_control_t

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Serialises and sends the contents of VL53L1_system_control_t data structure to the device

Definition at line 1309 of file vl53l1_register_funcs.c.

Functions

Detailed Description

Function Documentation

◆ VL53L1_get_customer_nvm_managed()

◆ VL53L1_get_nvm_copy_data()

◆ VL53L1_get_static_nvm_managed()

◆ VL53L1_get_system_results()

◆ VL53L1_i2c_decode_core_results()

◆ VL53L1_i2c_decode_customer_nvm_managed()

◆ VL53L1_i2c_decode_debug_results()

◆ VL53L1_i2c_decode_general_config()

◆ VL53L1_i2c_decode_nvm_copy_data()

◆ VL53L1_i2c_decode_static_config()

◆ VL53L1_i2c_decode_static_nvm_managed()

◆ VL53L1_i2c_decode_system_results()

◆ VL53L1_i2c_encode_customer_nvm_managed()

◆ VL53L1_i2c_encode_dynamic_config()

◆ VL53L1_i2c_encode_general_config()

◆ VL53L1_i2c_encode_static_config()

◆ VL53L1_i2c_encode_static_nvm_managed()

◆ VL53L1_i2c_encode_system_control()

◆ VL53L1_i2c_encode_timing_config()

◆ VL53L1_set_customer_nvm_managed()

◆ VL53L1_set_dynamic_config()

◆ VL53L1_set_general_config()

◆ VL53L1_set_static_config()

◆ VL53L1_set_static_nvm_managed()

◆ VL53L1_set_system_control()