Difference between revisions of "Template:E-Paper Cloud Module Manual"

Revision as of 11:15, 3 December 2020

You can download and install the APP by scanning the QR codes

Lead Information

Every time the device start, it will do partial refresh and display status icons.
Hereby provide the refrence of icons.


Waiting	Setting	Low Voltage	WIFI	Host

Waiting: The device is waiting for commands.
Setting: Setting is finished.
Low Voltage: The voltage of battareis is lower than warnning value.
WIFI: The wifi is connected.
Host: The devices is connected to target host by IP address.

Generally, you should press the button to wake up the device and check the icons. The warnning voltage is 3600mv, once the voltage is 150mv lower than warnning voltage (3450mv), the devices will shutdown automatically to protect the stable of the whole system.

1. Configure Device

1.1 First Setup

If you didn't configure the device before, you should configure the device by APP after pressing the Wakeup button to update the display①. Please refer to #1.4 Configure Device by APP to configure the device.②
Note：
①If the device isn't configured, Waiting icon is displaed in the top-right area. If the Low Voltage icon is displayed without Waiting, it means that the batteris is less than 3450mv and it is going to shutdown.
②If the device doesn't connect to Bluetooth, it will shutdown after 90s after booting and refreshing the display.

1.2 Reconfiguration

If the device was configured, the device will update and display Setted icon in the top-right area① after pressing wakeup button. The Bluetooth is disabled by default, if required, you should hold the wakeup button for 5s at least to enable the Bluetooth②. The updating process of device will not be interrupted③ while enabling the Bluetooth. After enabling the Bluetooth, you can re-configure the device by referring to #1.4 Configure Device by APP ④.
注：
①The update time of device is determined the speed of WIFI, It should less than 30s as we test.。
②You can holding the wakeup button untill your phone scan the device vi Bluetooth. Otherwise, the device auto-sutdown if the bluetooth is disconnected.。
③If you enable the Bluetooth of device, it will try to connet to master (phone) in 30s if th shutdown command is received via wifi. If the device is connected to phone by Bluetooth, it will keep waking, otherwise it will be turned off after 30s.
④You should reboot the device after configurating to make the configuration effect. Please do not reboot the device when transmitting data via WIFI, it will cost data losing.

1.3 APP Description

Bluetooth Connectiono Button and the information <br\>

Device ID: for distinguish devices<br\>

WIFI_SSID<br\>

Check the current SSID connected<br\>

WIFI_Password<br\>

Host_IP, The IP of host, for example, the IP of Raspberry Pi.<br\>

Device_IP: This is used to set the static IP. If you enable DHCP, the static IP is unavailable<br\>

Device_Password, you should input the device password to vertify if the device is locked.<br\>

Note: The default device password of Raspberry Pi example is 123456. If you lock the device you have to unlock it with password 123456, otherwise, the device cannot work.<br\>

Warning_voltage: If the voltage of batteries is less than the warning voltage, device will display the warnning icon. If the battert is 150mV lower than the warning voltage, device will shutdown automatically.<br\>

Load the configuration saved<br\>

Save the current configuration, you can save up to four sets of configuration<br\>

Upload the current configuration to device.<br\>

Formating: Clean the current configuration<br\>

1.4 Configure Device by APP

Ⅰ.Open APP（APP will auto-save the last configuration information）

Ⅱ.Click Bluetooth CONNECTION button, the default Bluetooth device is WaveShare_EPD or the Device ID configured.

Unparied

Paried

Ⅲ.Choose the device, for example connect the WaveShare_EPD. If you are the first time to connect the WaveShare_EPD device, it should be paired first.

Ⅳ. Modify the configuration information and Upload(If you have configured the password, you need to input the paddword as well.)

Ⅴ.The APP will disconnect and reboot the device if configuration are uploaded successfully.

Note: We recommend you to set static IP for device.

2. Communicating Protocol

The Communicating is divided into two modes: Command mode and the data mode. Command mode is used for sending command. data Mode is sued for sending image data to e-Paper.

Command Format

‘;’+Command（+Data）+'/'+Veriry

Data Format

0x57+4Byte addr+ 4Byte len +1Byte num + len Byte data +Verify

Return Format

'$'+Data+'#' The format of response of Command and Data are the same

Note:The Verity is the XOR result of data which is marked in red

Command Mode：

Command Format

‘;’+Comamnd（+Data）+'/'+Verify

Commands (locked)

These commands can be used if the device is locked.

Comamnds (unlocked)

These command can be used when the device is unlocked.

Data Mode：

Data Format

0x57+4Byte addr+ 4Byte len +1Byte num + len Byte data +Verify

Note：

Recommend you to transmit the frames with same lenght
The size of frame transmitted should not larger than 1100Byte, otherwise it cose data lose.
num should be static variable because it may be invalid because of version update.
The data frame doesn have stop bit, you need to wait for the verity data before sending the next frame, otherwise it causes failure.
The e-Paper will update automatically and exit from update mode when the addr and len are 0.

For mare detailes, please refer to the python3 examples provided.

@@ Line 1: / Line 1: @@
-=<big>'''e-Paper Cloud Module用户手册'''</big>=
 <big>
-<font color=red>'''APP可以通过浏览器扫描下方二维码进行下载'''</font><br />
+<font color=red>'''You can download and install the APP by scanning the QR codes'''</font><br />
 [[File:Cloud_APP.png|400px]]
-==<big><big>'''前置信息'''</big></big>==
+==<big><big>'''Lead Information'''</big></big>==
-本设备每次开机时会局部刷新屏幕，并显示对应状态的标志。
+Every time the device start, it will do partial refresh and display status icons.<br />
-以下图表分别是等待标志、设置标志、低电压标志、wifi连接标志和主机连接标志<br />
+Hereby provide the refrence of icons.<br />
 {| style="width:400px;"
 |-
 | [[File:Cloud_ESP32_e-Paper_Board_wait.png|32px]] || [[File:Cloud_ESP32_e-Paper_Board_set.png|32px]] || [[File:Cloud_ESP32_e-Paper_Board_batter.png|32px]] || [[File:Cloud_ESP32_e-Paper_Board_wifi.png|32px]] || [[File:Cloud_ESP32_e-Paper_Board_wifi_connect.png|32px]]
+|-
+|Waiting || Setting || Low Voltage || WIFI || Host
 |}
-*等待标志表示此时正在等待指令中。
+*Waiting: The device is waiting for commands.
-*设置标志表示是否设置完成。
+*Setting: Setting is finished.
-*低电压标志表示电池电压低于警告电压。
+*Low Voltage: The voltage of battareis is lower than warnning value.
-*wifi连接标志表示wifi已连接。
+*WIFI: The wifi is connected.
-*主机连接标志表示已经连接到指定IP地址的服务器。
+*Host: The devices is connected to target host by IP address.
-*一般情况下，开机后等待标志均会出现，但电池电压低于警戒电压（默认值为3600mv）150mv，为保护整个系统的稳定性，设备将自动关机。
+*Generally, you should press the button to wake up the device and check the icons. The warnning voltage is 3600mv, once the voltage is 150mv lower than warnning voltage (3450mv), the devices will shutdown automatically to protect the stable of the whole system.
-==<big><big>'''第1章 设备配置'''</big></big>==
+==<big><big>'''1. Configure Device'''</big></big>==
-===<big>'''1.1 首次配置'''</big>===
+===<big>'''1.1 First Setup'''</big>===
-如果设备尚未配置，按下设备唤醒键后，设备将进行刷屏后①，此时可以使用我们提供的app进行设置②,见1.3。<br />
+If you didn't configure the device before, you should configure the device by APP after pressing the Wakeup button to update the display①. Please refer to  [[#1.4 Configure Device by APP]] to configure the device.②<br />
-注：<br />
+Note：<br />
-①尚未配置的正常情况下，仅在右上角显示等待标志。如果显示低电压标志，且无等待标志则检测到电池电压低于3450mv将自动关机。<br />
+①If the device isn't configured, Waiting icon is displaed in the top-right area. If the Low Voltage icon is displayed without Waiting, it means that the batteris is less than 3450mv and it is going to shutdown.<br />
-②如果没有蓝牙连接到设备将在开机刷屏过后90s后自动关机。
+②If the device doesn't connect to Bluetooth, it will shutdown after 90s after booting and refreshing the display.
-===<big>'''1.2再配置'''</big>===
+===<big>'''1.2 Reconfiguration'''</big>===
-如果设备已经配置，按下设备唤醒键后，设备将进行刷屏①并在右上角将显示已设置标志，此时蓝牙默认关闭，需要长按唤醒键超过5S，用以开启蓝牙②。此时wifi刷屏动作将会照常进行③，配置操作与未配置设备一致 ④。<br />
+If the device was configured, the device will update and display Setted icon in the top-right area① after pressing wakeup button. The Bluetooth is disabled by default, if required, you should hold the wakeup button for 5s at least to enable the Bluetooth②. The updating process of device will not be interrupted③ while enabling the Bluetooth. After enabling the Bluetooth, you can re-configure the device by referring to [[#1.4 Configure Device by APP]] ④.<br />
 注：<br />
-①配置后设备的刷屏时间与wifi连接速度有直接联系，通常在开机后30s内进行刷新。<br />
+①The update time of device is determined the speed of WIFI, It should less than 30s as we test.。<br />
-②建议长按至手机搜索到设备蓝牙。没有蓝牙连接到设备将在开机刷屏过后90s后自动关机，若有蓝牙连接到设备则设备不会自动关机。<br />
+②You can holding the wakeup button untill your phone scan the device vi Bluetooth. Otherwise, the device auto-sutdown if the bluetooth is disconnected.。<br />
-③如果开启蓝牙情况下，接收到wifi设备的关机指令则等待30s蓝牙设备连接，若有蓝牙连接到设备则设备不会在蓝牙断开前关机；若无蓝牙连接到设备则关机。<br />
+③If you enable the Bluetooth of device, it will try to connet to master (phone) in 30s if th shutdown command is received via wifi. If the device is connected to phone by Bluetooth, it will keep waking, otherwise it will be turned off after 30s.<br />
-④通常配置完成后，需要进行重启，以使新配置生效。如果重启时，wifi正在传输数据，可能导致数据丢失。
+④You should reboot the device after configurating to make the configuration effect. Please do not reboot the device when transmitting data via WIFI, it will cost data losing.
-===<big>'''1.3APP界面介绍'''</big>===
+===<big>'''1.3 APP Description'''</big>===
 ::[[File:Cloud_Epd_app_1.png|300px]]
-::::'''<big>连接蓝牙按钮与蓝牙信息</big>''' <br\>
+::::'''<big>Bluetooth Connectiono Button and the information</big>''' <br\>
 ::[[File:Cloud_Epd_app_2.png|300px]]
-:::'''<big>设备ID，用于识别区分设备</big>'''<br\>
+:::'''<big>Device ID: for distinguish devices</big>'''<br\>
 ::[[File:Cloud_Epd_app_3.png|300px]]
-::'''<big>设备连接的无线网络名称（SSID）</big>'''<br\>
+::'''<big>WIFI_SSID</big>'''<br\>
 ::[[File:Cloud_Epd_app_4.png|300px]]
-:::'''<big>获取手机连接的无线网络名称</big>'''<br\>
+:::'''<big>Check the current SSID connected</big>'''<br\>
 ::[[File:Cloud_Epd_app_5.png|300px]]
-:::::'''<big>无线网络密码</big>'''<br\>
+:::::'''<big>WIFI_Password</big>'''<br\>
 ::[[File:Cloud_Epd_app_6.png|300px]]
-:::'''<big>主机IP，通常主机为树莓派</big>'''<br\>
+:::'''<big>Host_IP, The IP of host, for example, the IP of Raspberry Pi.</big>'''<br\>
 ::[[File:Cloud_Epd_app_8.png|300px]]
-::'''<big>静态IP设置，若开启DHCP则失效。</big>'''<br\>
+::'''<big>Device_IP: This is used to set the static IP. If you enable DHCP, the static IP is unavailable</big>'''<br\>
 ::[[File:Cloud_Epd_app_7.png|300px]]
-:'''<big>设备密码，上锁后需输入密码才能进行操作</big>'''<br\>
+:'''<big>Device_Password, you should input the device password to vertify if the device is locked.</big>'''<br\>
-注：树莓派例程使用密码为123456，如果上锁并密码不为123456则可能导致无法正常运行。<br\>
+Note: The default device password of Raspberry Pi example is 123456. If you lock the device you have to unlock it with password 123456, otherwise, the device cannot work.<br\>
 ::[[File:Cloud_Epd_app_9.png|300px]]
-'''<big>警告电压，低于电池设定电压则开机时显示低电量标志，若低于设定电压150mv则自动关机。</big>'''<br\>
+'''<big>Warning_voltage: If the voltage of batteries is less than the warning voltage, device will display the warnning icon. If the battert is 150mV lower than the warning voltage, device will shutdown automatically.</big>'''<br\>
 ::[[File:Cloud_Epd_app_10.png|300px]]
-::'''<big>导出保存过配置到当前配置界面</big>'''<br\>
+::'''<big>Load the configuration saved</big>'''<br\>
 ::[[File:Cloud_Epd_app_11.png|300px]]
-::'''<big> 保存当前配置，最多保存四套配置</big>'''<br\>
+::'''<big> Save the current configuration, you can save up to four sets of configuration</big>'''<br\>
 ::[[File:Cloud_Epd_app_12.png|300px]]
-::::'''<big>将当前配置上传至设备</big>'''<br\>
+::::'''<big>Upload the current configuration to device.</big>'''<br\>
 ::[[File:Cloud_Epd_app_13.png|300px]]
-::::'''<big> 清空当前设备配置信息</big>'''<br\>
+::::'''<big> Formating: Clean the current configuration</big>'''<br\>
-===<big>'''1.4使用APP进行配置'''</big>===
+===<big>'''1.4 Configure Device by APP'''</big>===
-::Ⅰ.打开APP（APP会自动保存上次上传成功的配置信息）
+::Ⅰ.Open APP（APP will auto-save the last configuration information）
 ::[[File:Cloud_ESP32_e-Paper_Board_manual_1.png|300px]]
-::Ⅱ.点击连接蓝牙按键，默认名为WaveShare_EPD,如果已经配置则为ID名。
+::Ⅱ.Click Bluetooth CONNECTION button, the default Bluetooth device is WaveShare_EPD or the Device ID configured.
-::[[File:Cloud_ESP32_e-Paper_Board_manual_2.png|300px|未配对]]
+::[[File:Cloud_ESP32_e-Paper_Board_manual_2.png|300px|Unpaired]]
-:::::::未配对
+:::::::Unparied
-::[[File:Cloud_ESP32_e-Paper_Board_manual_3.png|300px|已配对]]
+::[[File:Cloud_ESP32_e-Paper_Board_manual_3.png|300px|Paried]]
-:::::::已配对
+:::::::Paried
-::Ⅲ.点击想要连接的设备，我们这里点击WaveShare_EPD，如果第一次连接会要求配对，直接点击确定即可。（如果已配对，则没有这一步）
+::Ⅲ.Choose the device, for example connect the WaveShare_EPD. If you are the first time to connect the WaveShare_EPD device, it should be paired first.
 ::[[File:Cloud_ESP32_e-Paper_Board_manual_4.png|300px]]
-::Ⅳ. 修改对应的配置，点击上传配置按钮（如果设备已配置且有密码，则需要输入对应密码）
+::Ⅳ. Modify the configuration information and Upload(If you have configured the password, you need to input the paddword as well.)
 ::[[File:Cloud_ESP32_e-Paper_Board_manual_5.png|300px]]
-::Ⅴ.稍定片刻，下方提示信息显示上传成功，此时APP将断开蓝牙连接并重启设备
+::Ⅴ.The APP will disconnect and reboot the device if configuration are uploaded successfully.
 ::[[File:Cloud_ESP32_e-Paper_Board_manual_6.png|300px]]
-::注：尽可能给设备固定IP地址，以提高设备稳定性
+::Note: We recommend you to set static IP for device.
-==<big><big>'''第2章 通讯协议'''</big></big>==
+==<big><big>'''2. Communicating Protocol '''</big></big>==
-通讯主要分为两个模式，数据模式和指令模式，指令模式用于传输各种指令,数据模式则是用来传输屏幕刷新数据，两个发送数据格式也各有不同，具体如下：
+The Communicating is divided into two modes: Command mode and the data mode. Command mode is used for sending command. data Mode is sued for sending image data to e-Paper.
-====<big>'''指令格式'''</big>====
+====<big>'''Command Format'''</big>====
-‘;’+<font color=red>指令（+数据）</font>+&#39;/&#39;+校验
+‘;’+<font color=red>Command（+Data）</font>+&#39;/&#39;+Veriry
-====<big>'''数据格式'''</big>====
+====<big>'''Data Format'''</big>====
-x57+<font color=red>4Byte addr+ 4Byte len +1Byte num + len Byte data </font>+校验
+x57+<font color=red>4Byte addr+ 4Byte len +1Byte num + len Byte data </font>+Verify
-====<big>'''返回格式'''</big>====
+====<big>'''Return Format'''</big>====
-&#39;$&#39;+数据+&#39;#&#39;
+&#39;$&#39;+Data+&#39;#&#39;
-无论数据格式还是指令模式,返回格式均一致。
+The format of response of Command and Data are the same
-注：<font color=red>校验为红色数据部分的异或。</font>
+Note:<font color=red>The Verity is the XOR result of data which is marked in red </font>
-==='''指令模式下：'''===
+==='''Command Mode：'''===
-====指令格式====
+====Command Format====
-::‘;’+<font color=red>指令（+数据）</font>+&#39;/&#39;+校验
+::‘;’+<font color=red>Comamnd（+Data）</font>+&#39;/&#39;+Verify
-====未解锁可用指令====
+====Commands (locked)====
 [[File:Cloud_ESP32_e-Paper_Board_manual_7.png|700px]]
-====解锁可用指令====
+:These commands can be used if the device is locked.
+====Comamnds (unlocked)====
 [[File:Cloud_ESP32_e-Paper_Board_manual_8.png|700px]]
+:These command can be used when the device is unlocked.
-==='''数据模式下：'''===
+==='''Data Mode：'''===
-====数据格式====
+====Data Format====
-::0x57+<font color=red>4Byte addr+ 4Byte len +1Byte num + len Byte data </font>+校验
+::0x57+<font color=red>4Byte addr+ 4Byte len +1Byte num + len Byte data </font>+Verify
 [[File:Cloud_ESP32_e-Paper_Board_manual_9.png|700px]]
-====注意：====
+====Note：====
-#建议使用等长帧传输
+#Recommend you to transmit the frames with same lenght
-#<font color="red">'''每次传输数据长度不应超过1100Byte，否则将会导致数据丢失.'''</font>
+#<font color="red">'''The size of frame transmitted should not larger than 1100Byte, otherwise it cose data lose.'''</font>
-#num因版本升级而失去作用，可为恒定值。
+#num should be static variable because it may be invalid because of version update.
-#数据帧无结束位，应当等待返回对应校验位后才能发送下一帧，否则可能导致系统崩溃或重启。
+#The data frame doesn have stop bit, you need to wait for the verity data before sending the next frame, otherwise it causes failure.
-#当addr和len均为0时，退出刷新模式。并自动刷新屏幕。
+#The e-Paper will update automatically and exit from update mode when the addr and len are 0.
-具体流程也可以参考我司提供的python3例程<br />
+For mare detailes, please refer to the python3 examples provided.<br />
 </big>

Navigation menu

Difference between revisions of "Template:E-Paper Cloud Module Manual"

Revision as of 11:15, 3 December 2020

Contents

Lead Information

1. Configure Device

1.1 First Setup

1.2 Reconfiguration

1.3 APP Description

1.4 Configure Device by APP

2. Communicating Protocol

Command Format

Data Format

Return Format

Command Mode：

Command Format

Commands (locked)

Comamnds (unlocked)

Data Mode：

Data Format

Note：