Addressable LED Functions

Functions
HAL_AddressableLEDHandle	HAL_InitializeAddressableLED (int32_t channel, const char *allocationLocation, int32_t *status)
	Creates a new instance of an addressable LED.
void	HAL_FreeAddressableLED (HAL_AddressableLEDHandle handle)
	Free the Addressable LED Handle.
void	HAL_SetAddressableLEDStart (HAL_AddressableLEDHandle handle, int32_t start, int32_t *status)
	Sets the start buffer location used for the LED strip.
void	HAL_SetAddressableLEDLength (HAL_AddressableLEDHandle handle, int32_t length, int32_t *status)
	Sets the length of the LED strip.
void	HAL_SetAddressableLEDData (int32_t start, int32_t length, HAL_AddressableLEDColorOrder colorOrder, const struct HAL_AddressableLEDData *data, int32_t *status)
	Sets the led output data.

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	(	int32_t	channel,
		const char *	allocationLocation,
		int32_t *	status )

Creates a new instance of an addressable LED.

Parameters

[in]	channel	the smartio channel
[in]	allocationLocation	the location where the allocation is occurring (can be null)
[out]	status	the error code, or 0 for success

Returns

Addressable LED handle

HAL_SetAddressableLEDData()

void HAL_SetAddressableLEDData	(	int32_t	start,
		int32_t	length,
		HAL_AddressableLEDColorOrder	colorOrder,
		const struct HAL_AddressableLEDData *	data,
		int32_t *	status )

Sets the led output data.

All addressable LEDs use a single backing buffer 1024 LEDs in size. This function may be used to set part of or all of the buffer.

Parameters

[in]	start	the strip start, in LEDs
[in]	length	the strip length, in LEDs
[in]	colorOrder	the color order
[in]	data	the buffer to write
[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.

All addressable LEDs use a single backing buffer 1024 LEDs in size. The max length for a single output is 1024 LEDs (with an offset of zero).

Parameters

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

HAL_SetAddressableLEDStart()

void HAL_SetAddressableLEDStart	(	HAL_AddressableLEDHandle	handle,
		int32_t	start,
		int32_t *	status )

Sets the start buffer location used for the LED strip.

All addressable LEDs use a single backing buffer 1024 LEDs in size. The max length for a single output is 1024 LEDs (with an offset of zero).

Parameters

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