Difference between revisions of "EPD-660 user guide"

From ESS-WIKI
Jump to: navigation, search
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
= '''EPD-132 B3 User Guide''' =
+
 
−
EPD-660、EPD-662 user guide introduce how to deploy device to ePaper Manager and behavior of button and led
+
= '''EPD-660、EPD-662 User Guide''' =
 +
 
 +
EPD-660、EPD-662 are 13.3 e-paper display user guide introduce method that device deploy to ePaper Manager server and function list of individual button and behavior of the different lights of led indicator.
  
 
== Deploy Setting ==
 
== Deploy Setting ==
 +
 +
ePaper Manager server can manager device and issue commands to device so we need device connect to server. Due to there are no interface to configure information of wireless on EPD so we need configure information of wireless on gateway of WISE-32xx series.
 +
 +
EPD device connect to AP of WISE-32xx that SSID and passowrd are ADV-ePape/ePaperePaper so it need check wireless information is match with device.
 +
 +
Basic deploy flow as blow
 +
 +
[[File:EpdDeploy1.jpg|200px|ePaper deploy]] [[File:Wifideploy.JPG|800px|3270 deploy flow2]]
 +
 +
step 1: Configure information on gateway.
 +
 +
User setup the MAC Address of EPD, SSID of AP ,Password of AP ,IP of ePaper Manager Server and Server Port: 5853 on web of WISE-32xx.
 +
 +
[[File:3200dp1.jpg|800px|3270 wifi deploy 1.jpg]]
 +
 +
'''EPD deploy on wise-3200 reference''' [[Wise32xxweb/LuCI#EPD_Deployment|'''WISE-32xx deployment configuration''']]
 +
 +
step 2: EPD device reset to default.
 +
 +
Pressed button 1 keep 8 seconds and green led light, then release button.EPD will connect to WISE-3220 AP after reset to default.
 +
 +
[[File:Pd132b3 3.jpg|500px|wake button]]
 +
 +
step 3: Check device list on ePaper Manager server
 +
 +
[[File:Epd132b3 4.jpg|300px|ePaper]]
 +
 +
Add device to group by MAC address
 +
 +
[[File:Epd132b3 5.jpg|500px|ePaper list]]
  
 
== Button ==
 
== Button ==
  
−
Five buttons on EPD Panel and function from top to the bottom
+
There are five buttons on EPD panel. Button 1 could wake up or reset system and function of button 2~4 can refresh panel and total page of EPD device has 14 pages and image file have to download from ePaper manager server.
  
−
Button 1 : Wake up/carousel switch/reset to default
+
Function from top to the bottom description as below.
  
−
Button 2 : Forward/bottom
+
[[File:132B3 btn.jpg|500px|system button]]
  
−
Press this button below 2 seconds that is next page and bottom page is pressed over 3 seconds
+
=== Button 1 ===
  
−
Button 3 : Backward/First
+
EPD is with battery device so device is always in deep sleep for power saving. Function of Button 1 could wake up from deep sleep and changing device to run mode from deep sleep mode.
  
−
Press this button below 2 seconds that is previous page and first page is pressed over 3 seconds
+
Button behavior
  
−
Button 4 : Page 13
+
Wake up:Click button
  
−
Press this button to refresh page 13 on EPD
+
reset to default: Pressed button keep 8 seconds then button release.
  
−
Button 5 : Page 14
+
=== Button 2 ===
  
−
Press this button to refresh page 14 on EPD
+
Refresh image to next page after button click but the bottom of index is 12 and it also pause with 60 seconds when carousel mode is start.
  
−
== LED ==
+
It fast to change the final page by pressed button keep 3 seconds then button release.
  
−
LED behavior of description as below
+
For example user download image file to index 1、3、5、7、12, index change to 3 after button click if orginal index is 1.
  
−
Green LED lighting scenario
+
Index change to 12 by button pressed keep 3 seconds then button release if index is 1.
 +
 
 +
Button behavior
 +
 
 +
Forward/carousel mode pause/Alert status stop: Click button
 +
 
 +
bottom : Pressed button keep 3 seconds then button release
 +
 
 +
=== Button 3 ===
 +
 
 +
Refresh image to previous page after button click but the first of index is 1 and it also pause with 60 seconds when carousel mode is start. It fast to change the first page by pressed button keep 3 seconds then button release.
 +
 
 +
For example user download image file to index 3、5、7、12, index change to 3 after button click if index is 5.
 +
 
 +
Index change to 1 by button pressed keep 3 seconds then button release if index is 12.
 +
 
 +
Button behavior
 +
 
 +
Backward/carousel mode pause/Alert status stop: Click button
 +
 
 +
First: Pressed button keep 3 seconds
 +
 
 +
=== Button 4 ===
 +
 
 +
Refresh image to page of 13 after button click on EPD and after 60 seconds, it will return to page in 1~12.
 +
 
 +
It also pause carousel mode in 60 seconds when carousel mode is start.
 +
 
 +
Button behavior
 +
 
 +
Page 13/carousel mode pause/Alert status stop:Click button
 +
 
 +
=== Button 5 ===
 +
 
 +
Refresh image to page of 14 after button click on EPD and after 60 seconds, it will return to page in 1~12.
 +
 
 +
Function of carousel switch that does work after device accept command from ePaper manager server so user have to make sure send carousel command from server.
 +
 
 +
It also pause carousel mode in 60 seconds when carousel mode is start.
 +
 
 +
Button behavior
 +
 
 +
Page 14/carousel mode pause/Alert status stop:Click button
 +
 
 +
Cauousel mode switch function: Pressed button 3 second then green led blink. Release button carousel mode is on or off after user have to set up carousel mode variable on ePaper Manager server.
 +
 
 +
== LED Indicator ==
 +
 
 +
Device has green and red led indicator and description of led behavior as below
 +
 
 +
[[File:Epd132b3 1.jpg|300px|Green Led]] [[File:Epd132b3 2.jpg|340px|Red Led]]
 +
 
 +
=== Green LED lighting ===
 +
 
 +
scenario
  
 
a. Button pressed
 
a. Button pressed
  
−
b. Battery charging
+
b. Battery charging(device with battery ): led turn off when batter charge to 100%
 +
 
 +
c. DC in (device without battery)
 +
 
 +
=== Green LED blink ===
 +
 
 +
scenario and flow
 +
 
 +
a. Image Download to flash :Led lighting -> Image Download to flash -> Image Download to flash done -> Led turn off
 +
 
 +
=== Red LED lighting ===
 +
 
 +
scenario and flow
 +
 
 +
a. Alert command : Accept command from server -> Led lighting -> click button -> Led turn off
 +
 
 +
=== Red LED blink ===
 +
 
 +
a. Battery Error: The battery is unnormal.
 +
 
 +
== Device mode ==
 +
 
 +
Device has 3 status but device may be in one or two status in the same time. For example device statue can be in charging and carousel mode when plugged the charger.
 +
 
 +
every mode has own behavior description as below
 +
 
 +
=== Normal mode ===
 +
 
 +
Factory setting is normal mode and routine step as below.
 +
 
 +
a. device wake up from RTC.
 +
 
 +
b. Wireless connect Server through Wifi AP and default AP SSID & Password are ADV-ePaper/ePaperePaper
 +
 
 +
c. Check any command of action from server and report status
 +
 
 +
d. device go to power saving when it's idle
 +
 
 +
=== Carousel mode ===
 +
 
 +
Device accept command of configuration from ePaper manager server to enter carousel mode and then device refresh image every interval time.
 +
 
 +
variable of command
 +
 
 +
a. start page
 +
 
 +
b. end page
 +
 
 +
c. interval time in second
 +
 
 +
=== Charging mode ===
 +
 
 +
Device enter charging mode after device wake up from button or RTC clock then plugged the charger and device stop to sleep mode and LED always light.
 +
 
 +
Note: device could not wake up by plugged charger when device is status in deep sleep unless it wake up from RTC or button but it still can charge battery.
 +
 
 +
a. DC power in
 +
 
 +
== Battery status ==
 +
 
 +
=== Full battery ===
 +
 
 +
The full battery icon display right bottom when Battery charge over 90%
 +
 
 +
[[File:EPD 660 Battery full.jpg|300px|EPD 660 low battery icon]]
 +
 
 +
=== Low battery ===
 +
 
 +
The Low battery icon display right bottom when Battery Electricity less 15 %
 +
 
 +
[[File:Battery low.jpg|300px|EPD 660 low battery icon]]
 +
 
 +
=== Battery error ===
 +
 
 +
The error battery icon display right bottom when battery electricity is too lower  and it need adapter offer 9V to charge for 12 hours
 +
 
 +
[[File:EPD660Battery error.jpg|300px|EPD 660 error battery icon]]
 +
 
 +
 
 +
== API function ==
 +
 
 +
API function control behavior of device through ePaper manager server.
 +
 
 +
it show list of API in this document but operation manual is in ePaper manager server.
 +
 
 +
1. [node sync period] range of value is 1~65534 and unit is second
 +
 
 +
2. [state report period] range of value is 1~ 65535 and unit is minute
 +
 
 +
3. [clear-image-page] range of value is 1~14
 +
 
 +
4. [max-image-page] range of value 1~14
  
−
Green LED blink
+
5. [reboot] on/off
  
−
a. Image Download to flash
+
6. [reset to default] on/off
  
−
Red LED lighting scenario
+
7. [set alert status] on/off
  
−
a. Image refresh
+
8. [set ssid pw] ex. ADV-ePaper, ePaperePaper (ssid,password)
  
−
b. Alert command
+
9. [set carousel mode] ex. 1, 0, 5 ,30 (on or off , start page, end page , interval)
  
−
Red LED blink
+
10. [image update]
  
−
a. Battery Error
+
11. [image refresh]

Latest revision as of 06:45, 26 October 2022

EPD-660、EPD-662 User Guide

EPD-660、EPD-662 are 13.3 e-paper display user guide introduce method that device deploy to ePaper Manager server and function list of individual button and behavior of the different lights of led indicator.

Deploy Setting

ePaper Manager server can manager device and issue commands to device so we need device connect to server. Due to there are no interface to configure information of wireless on EPD so we need configure information of wireless on gateway of WISE-32xx series.

EPD device connect to AP of WISE-32xx that SSID and passowrd are ADV-ePape/ePaperePaper so it need check wireless information is match with device.

Basic deploy flow as blow

ePaper deploy 3270 deploy flow2

step 1: Configure information on gateway.

User setup the MAC Address of EPD, SSID of AP ,Password of AP ,IP of ePaper Manager Server and Server Port: 5853 on web of WISE-32xx.

3270 wifi deploy 1.jpg

EPD deploy on wise-3200 reference WISE-32xx deployment configuration

step 2: EPD device reset to default.

Pressed button 1 keep 8 seconds and green led light, then release button.EPD will connect to WISE-3220 AP after reset to default.

wake button

step 3: Check device list on ePaper Manager server

ePaper

Add device to group by MAC address

ePaper list

Button

There are five buttons on EPD panel. Button 1 could wake up or reset system and function of button 2~4 can refresh panel and total page of EPD device has 14 pages and image file have to download from ePaper manager server.

Function from top to the bottom description as below.

system button

Button 1

EPD is with battery device so device is always in deep sleep for power saving. Function of Button 1 could wake up from deep sleep and changing device to run mode from deep sleep mode.

Button behavior

Wake up:Click button

reset to default: Pressed button keep 8 seconds then button release.

Button 2

Refresh image to next page after button click but the bottom of index is 12 and it also pause with 60 seconds when carousel mode is start.

It fast to change the final page by pressed button keep 3 seconds then button release.

For example user download image file to index 1、3、5、7、12, index change to 3 after button click if orginal index is 1.

Index change to 12 by button pressed keep 3 seconds then button release if index is 1.

Button behavior

Forward/carousel mode pause/Alert status stop: Click button

bottom : Pressed button keep 3 seconds then button release

Button 3

Refresh image to previous page after button click but the first of index is 1 and it also pause with 60 seconds when carousel mode is start. It fast to change the first page by pressed button keep 3 seconds then button release.

For example user download image file to index 3、5、7、12, index change to 3 after button click if index is 5.

Index change to 1 by button pressed keep 3 seconds then button release if index is 12.

Button behavior

Backward/carousel mode pause/Alert status stop: Click button

First: Pressed button keep 3 seconds

Button 4

Refresh image to page of 13 after button click on EPD and after 60 seconds, it will return to page in 1~12.

It also pause carousel mode in 60 seconds when carousel mode is start.

Button behavior

Page 13/carousel mode pause/Alert status stop:Click button

Button 5

Refresh image to page of 14 after button click on EPD and after 60 seconds, it will return to page in 1~12.

Function of carousel switch that does work after device accept command from ePaper manager server so user have to make sure send carousel command from server.

It also pause carousel mode in 60 seconds when carousel mode is start.

Button behavior

Page 14/carousel mode pause/Alert status stop:Click button

Cauousel mode switch function: Pressed button 3 second then green led blink. Release button carousel mode is on or off after user have to set up carousel mode variable on ePaper Manager server.

LED Indicator

Device has green and red led indicator and description of led behavior as below

Green Led Red Led

Green LED lighting

scenario

a. Button pressed

b. Battery charging(device with battery ): led turn off when batter charge to 100%

c. DC in (device without battery)

Green LED blink

scenario and flow

a. Image Download to flash :Led lighting -> Image Download to flash -> Image Download to flash done -> Led turn off

Red LED lighting

scenario and flow

a. Alert command : Accept command from server -> Led lighting -> click button -> Led turn off

Red LED blink

a. Battery Error: The battery is unnormal.

Device mode

Device has 3 status but device may be in one or two status in the same time. For example device statue can be in charging and carousel mode when plugged the charger.

every mode has own behavior description as below

Normal mode

Factory setting is normal mode and routine step as below.

a. device wake up from RTC.

b. Wireless connect Server through Wifi AP and default AP SSID & Password are ADV-ePaper/ePaperePaper

c. Check any command of action from server and report status

d. device go to power saving when it's idle

Carousel mode

Device accept command of configuration from ePaper manager server to enter carousel mode and then device refresh image every interval time.

variable of command

a. start page

b. end page

c. interval time in second

Charging mode

Device enter charging mode after device wake up from button or RTC clock then plugged the charger and device stop to sleep mode and LED always light.

Note: device could not wake up by plugged charger when device is status in deep sleep unless it wake up from RTC or button but it still can charge battery.

a. DC power in

Battery status

Full battery

The full battery icon display right bottom when Battery charge over 90%

EPD 660 low battery icon

Low battery

The Low battery icon display right bottom when Battery Electricity less 15 %

EPD 660 low battery icon

Battery error

The error battery icon display right bottom when battery electricity is too lower and it need adapter offer 9V to charge for 12 hours

EPD 660 error battery icon


API function

API function control behavior of device through ePaper manager server.

it show list of API in this document but operation manual is in ePaper manager server.

1. [node sync period] range of value is 1~65534 and unit is second

2. [state report period] range of value is 1~ 65535 and unit is minute

3. [clear-image-page] range of value is 1~14

4. [max-image-page] range of value 1~14

5. [reboot] on/off

6. [reset to default] on/off

7. [set alert status] on/off

8. [set ssid pw] ex. ADV-ePaper, ePaperePaper (ssid,password)

9. [set carousel mode] ex. 1, 0, 5 ,30 (on or off , start page, end page , interval)

10. [image update]

11. [image refresh]

Retrieved from "https://ess-wiki.advantech.com.tw/wiki/index.php?title=EPD-660_user_guide&oldid=25740"