Addressable LED Functions

Functions
HAL_AddressableLEDHandle	HAL_InitializeAddressableLED (HAL_DigitalHandle outputPort, int32_t *status)
	Initialize Addressable LED using a PWM Digital handle. More...
void	HAL_FreeAddressableLED (HAL_AddressableLEDHandle handle)
	Free the Addressable LED Handle. More...
void	HAL_SetAddressableLEDOutputPort (HAL_AddressableLEDHandle handle, HAL_DigitalHandle outputPort, int32_t *status)
	Set the Addressable LED PWM Digital port. More...
void	HAL_SetAddressableLEDLength (HAL_AddressableLEDHandle handle, int32_t length, int32_t *status)
	Sets the length of the LED strip. More...
void	HAL_WriteAddressableLEDData (HAL_AddressableLEDHandle handle, const struct HAL_AddressableLEDData *data, int32_t length, int32_t *status)
	Sets the led output data. More...
void	HAL_SetAddressableLEDBitTiming (HAL_AddressableLEDHandle handle, int32_t highTime0NanoSeconds, int32_t lowTime0NanoSeconds, int32_t highTime1NanoSeconds, int32_t lowTime1NanoSeconds, int32_t *status)
	Sets the bit timing. More...
void	HAL_SetAddressableLEDSyncTime (HAL_AddressableLEDHandle handle, int32_t syncTimeMicroSeconds, int32_t *status)
	Sets the sync time. More...
void	HAL_StartAddressableLEDOutput (HAL_AddressableLEDHandle handle, int32_t *status)
	Starts the output. More...
void	HAL_StopAddressableLEDOutput (HAL_AddressableLEDHandle handle, int32_t *status)
	Stops the output. More...

Detailed Description

Function Documentation

HAL_FreeAddressableLED()

void HAL_FreeAddressableLED

(

HAL_AddressableLEDHandle

handle

)

Free the Addressable LED Handle.

Parameters

[in]

handle

the Addressable LED handle to free

HAL_InitializeAddressableLED()

HAL_AddressableLEDHandle HAL_InitializeAddressableLED	(	HAL_DigitalHandle	outputPort,
		int32_t *	status
	)

Initialize Addressable LED using a PWM Digital handle.

Parameters

[in]	outputPort	handle of the digital port for PWM
[out]	status	the error code, or 0 for success

Returns

Addressable LED handle

HAL_SetAddressableLEDBitTiming()

void HAL_SetAddressableLEDBitTiming	(	HAL_AddressableLEDHandle	handle,
		int32_t	highTime0NanoSeconds,
		int32_t	lowTime0NanoSeconds,
		int32_t	highTime1NanoSeconds,
		int32_t	lowTime1NanoSeconds,
		int32_t *	status
	)

Sets the bit timing.

By default, the driver is set up to drive WS2812Bs, so nothing needs to be set for those.

Parameters

[in]	handle	the Addressable LED handle
[in]	highTime0NanoSeconds	high time for 0 bit (default 400ns)
[in]	lowTime0NanoSeconds	low time for 0 bit (default 900ns)
[in]	highTime1NanoSeconds	high time for 1 bit (default 900ns)
[in]	lowTime1NanoSeconds	low time for 1 bit (default 600ns)
[out]	status	the error code, or 0 for success

HAL_SetAddressableLEDLength()

void HAL_SetAddressableLEDLength	(	HAL_AddressableLEDHandle	handle,
		int32_t	length,
		int32_t *	status
	)

Sets the length of the LED strip.

The max length is 5460 LEDs.

Parameters

[in]	handle	the Addressable LED handle
[in]	length	the strip length
[out]	status	the error code, or 0 for success

HAL_SetAddressableLEDOutputPort()

void HAL_SetAddressableLEDOutputPort	(	HAL_AddressableLEDHandle	handle,
		HAL_DigitalHandle	outputPort,
		int32_t *	status
	)

Set the Addressable LED PWM Digital port.

Parameters

[in]	handle	the Addressable LED handle
[in]	outputPort	The digital handle of the PWM port
[out]	status	the error code, or 0 for success

HAL_SetAddressableLEDSyncTime()

void HAL_SetAddressableLEDSyncTime	(	HAL_AddressableLEDHandle	handle,
		int32_t	syncTimeMicroSeconds,
		int32_t *	status
	)

Sets the sync time.

The sync time is the time to hold output so LEDs enable. Default set for WS2812B.

Parameters

[in]	handle	the Addressable LED handle
[in]	syncTimeMicroSeconds	the sync time (default 280us)
[out]	status	the error code, or 0 for success

HAL_StartAddressableLEDOutput()

void HAL_StartAddressableLEDOutput	(	HAL_AddressableLEDHandle	handle,
		int32_t *	status
	)

Starts the output.

The output writes continuously.

Parameters

[in]	handle	the Addressable LED handle
[out]	status	the error code, or 0 for success

HAL_StopAddressableLEDOutput()

void HAL_StopAddressableLEDOutput	(	HAL_AddressableLEDHandle	handle,
		int32_t *	status
	)

Stops the output.

Parameters

[in]	handle	the Addressable LED handle
[out]	status	the error code, or 0 for success

HAL_WriteAddressableLEDData()

void HAL_WriteAddressableLEDData	(	HAL_AddressableLEDHandle	handle,
		const struct HAL_AddressableLEDData *	data,
		int32_t	length,
		int32_t *	status
	)

Sets the led output data.

If the output is enabled, this will start writing the next data cycle. It is safe to call, even while output is enabled.

Parameters

[in]	handle	the Addressable LED handle
[in]	data	the buffer to write
[in]	length	the strip length
[out]	status	the error code, or 0 for success