ws2812_avr.h File Reference

Provides AVR platform specific definitions. More...

#include <stdint.h>
#include "ws2812_common.h"
#include "ws2812.h"

Include dependency graph for ws2812_avr.h:

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

Go to the source code of this file.

Classes
struct	ws2812_cfg
	ALL PLATFORMS: Data structure to configure a WS2812 device struct. More...
struct	ws2812
	ALL PLATFORMS: WS2812 device struct to drive one or more WS2812 devices. More...

Typedefs
typedef struct ws2812_cfg	ws2812_cfg
	ALL PLATFORMS: Data structure to configure a WS2812 device struct. More...
typedef struct ws2812	ws2812
	ALL PLATFORMS: WS2812 device struct to drive one or more WS2812 devices. More...

Detailed Description

Provides AVR platform specific definitions.

Author

Patrick Pedersen

Date

2021-04-16

Definition in file ws2812_avr.h.

Typedef Documentation

ws2812

typedef struct ws2812 ws2812

ALL PLATFORMS: WS2812 device struct to drive one or more WS2812 devices.

The following struct is used to drive one or more WS2812 devices. It is initialized by the ws2812_config() function and is taken as an argument by practically every function of the TinyWS2812 library relevant to driving WS2812 devices (ex. ws2812_tx(), ws2812_prep_tx(), etc...).

See also

ws2812_config()

ws2812_cfg

typedef struct ws2812_cfg ws2812_cfg

ALL PLATFORMS: Data structure to configure a WS2812 device struct.

The following struct is used to initialize/configure a WS2812 device struct It is passed to the ws2812_config() function along with a reference to a WS2812 device struct, and contains relevant information such as pins used to drive WS2812 devices, the device's reset time etc.

This struct vareies between platforms, and is defined in the platform specific header file (ws2812_PLATFORM.h).

Warning

All fields of the configuration object must be defined before passing it to ws2812_config()! Leaving a field undefined will result in undefined behaivor!