driver ws2812b header file More...

#include <stdint.h>
#include <stdio.h>
#include <string.h>

Include dependency graph for driver_ws2812b.h:

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

Data Structures
struct	ws2812b_handle_s
	ws2812b handle structure definition More...
struct	ws2812b_info_s
	ws2812b information structure definition More...

Macros
#define	WS2812B_EACH_RESET_BIT_FRAME_LEN 512
	ws2812b each reset bit frame length definition
#define	DRIVER_WS2812B_LINK_INIT(HANDLE, STRUCTURE)
	initialize ws2812b_handle_t structure
#define	DRIVER_WS2812B_LINK_SPI_10MHZ_INIT(HANDLE, FUC)
	link spi_10mhz_init function
#define	DRIVER_WS2812B_LINK_SPI_DEINIT(HANDLE, FUC)
	link spi_deinit function
#define	DRIVER_WS2812B_LINK_SPI_WRITE_COMMAND(HANDLE, FUC)
	link spi_write_cmd function
#define	DRIVER_WS2812B_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_WS2812B_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct ws2812b_handle_s	ws2812b_handle_t
	ws2812b handle structure definition
typedef struct ws2812b_info_s	ws2812b_info_t
	ws2812b information structure definition

Functions
uint8_t	ws2812b_info (ws2812b_info_t *info)
	get chip's information
uint8_t	ws2812b_init (ws2812b_handle_t *handle)
	initialize the chip
uint8_t	ws2812b_deinit (ws2812b_handle_t *handle)
	close the chip
uint8_t	ws2812b_write (ws2812b_handle_t handle, uint32_t rgb, uint32_t len, uint8_t *temp, uint32_t temp_len)
	write reset and color frame
uint8_t	ws2812b_write_only_reset (ws2812b_handle_t handle, uint32_t len, uint8_t temp, uint32_t temp_len)
	write the reset frame
uint8_t	ws2812b_write_only_color (ws2812b_handle_t handle, uint32_t rgb, uint32_t len, uint8_t *temp, uint32_t temp_len)
	write the color frame
uint8_t	ws2812b_set_reg (ws2812b_handle_t handle, uint8_t buf, uint16_t len)
	set the chip register

Detailed Description

driver ws2812b header file

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version: 1.0.0

Author: Shifeng Li

Date: 2021-11-13

history

Date	Version	Author	Description
2021/11/13	1.0	Shifeng Li	first upload

Definition in file driver_ws2812b.h.

Data Structures

Macros

Typedefs

Functions

Detailed Description

history