README_cn.md

ATOM Library

中文 | English

描述

ATOM Matrix 与 ATOM Lite 是一款基于ESP32-PICO-D4的迷你开发板内置蓝牙和wifi，大小只有24*24mm，ATOM系列开发板包含IR，RGB LED, 按键和PH2.0接口，提供6个GPIO引脚。相比 ATOM Lite，ATOM Matrix拥有5 * 5 RGB LED矩阵和MPU6886.

PinMap

Neo	GPIO27
Btn	GPIO39
CLK(MPU6886)	GPIO21
SDA(MPU6886)	GPIO25
IR	GPIO12
Btn	GPIO39

GROVE interface

ESP32 chip	GPIO32	GPIO26	5V	GND
PH2.0 interface	SCL	SDA	5V	GND

Display API Document

Public Types

enum	Am_mode{kMoveRight,kMoveLeft,kMoveTop,kMoveButtom}

Public Functions

void	animation(uint8_t *buffptr, uint8_t amspeed, uint8_t ammode, int64_t amcount = -1)
void	displaybuff(uint8_t *buffptr, int8_t offsetx = 0, int8_t offsety = 0)
void	MoveDisPlayBuff(int8_t offsetx = 0, int8_t offsety = 0)
void	setBrightness(uint8_t brightness)
void	drawpix(uint8_t xpos, uint8_t ypos, CRGB Color)
void	drawpix(uint8_t Number, CRGB Color)
void	fillpix(CRGB Color)
void	clear()

enum Am_mode

Constant	Value	Description
LED_Display::kMoveRight	0x01	Move the image to the right
LED_Display::kMoveLeft	0x02	Move the image to the left
LED_Display::kMoveTop	0x04	Move the image to the top
LED_Display::kMoveButtom	0x08	Move the image to the buttom

Member Function Documentation

---

    void animation(uint8_t *buffptr, uint8_t amspeed, uint8_t ammode, int64_t amcount = -1)

Start moving animation of an image

parameter list

名称	类型	范围	默认值	描述
buffptr	uint8_t*	-	-	Image pointer
amspeed	uint8_t	0 ~ MAXSIZE of uint8_t	-	Time interval of image movement
ammode	uint8_t	See also Am_mode	-	Animation mode of image movement
amcount	int64_t	-1 ~ MAXSIZE of int64_t	-1	The distance the image moves (pixels)

return value
无

---

    void displaybuff(uint8_t *buffptr, int8_t offsetx = 0, int8_t offsety = 0)

Display an image

parameter list

名称	类型	范围	默认值	描述
buffptr	uint8_t*	-	-	Image pointer
offsetx	uint8_t	-127 ~ 127	0	Horizontal image offset
offsety	uint8_t	-127 ~ 127	0	Vertical image offset

return value
无

---

    void MoveDisPlayBuff(int8_t offsetx = 0, int8_t offsety = 0)

Move the image data in the display buff

parameter list

名称	类型	范围	默认值	描述
offsetx	int8_t	-127 ~ 127	0	Horizontal image offset
offsety	int8_t	-127 ~ 127	0	Vertical image offset

return value
无

---

    void setBrightness(uint8_t brightness)

Set the Leds Brightness
Warning: It is not recommended to set the LED brightness to 100. Setting the LED brightness to 100 may cause overheating

parameter list

名称	类型	范围	默认值	描述
brightness	uint8_t	0 ~ 100	-	Brightness of Leds

return value
无

---

    void drawpix(uint8_t xpos, uint8_t ypos, CRGB Color)

Set the color of a LED in coordinate mode

parameter list

名称	类型	范围	默认值	描述
xpos	uint8_t	0 ~ 255	0	coordinate x
ypos	uint8_t	0 ~ 255	0	coordinate y
Color	CRGB	-	-	Color of Led

return value
无

---

    void drawpix(uint8_t Number, CRGB Color)

Set the color of a LED

parameter list

名称	类型	范围	默认值	描述
Number	uint8_t	0 ~ 255	0	number of Led
Color	CRGB	-	-	Color of Led

return value
无

---

    void fillpix(CRGB Color)

Set the color of all LEDs

parameter list

名称	类型	范围	默认值	描述
Color	CRGB	-	-	Color of Leds

return value
无

---

    void clear()

Close all of LEDs

parameter list
无

return value
无