HKT101BTA-C
LCD Module User Manual
Prepared by:
Checked by:
Approved by:
WangGang
DingXin
Date: 2024-03-12
Date:
Date: 2024-03-12
Rev. Descriptions
Edit
Release Date
0.1
Preliminary release
WangGang
2024-01-18
0.2
Update Product Outline & Mounting
WangGang
2024-03-12
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 1 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
Table of Content
1. Basic Specification................................................................................................................................ 3
1.1 General Specification......................................................................................................................3
1.2 Block Diagram.................................................................................................................................3
1.3 Terminal Function........................................................................................................................... 4
1.3.1 UART Interface Terminal (K3)............................................................................................. 4
1.3.2 USB TYPE-C Interface Terminal (K2)................................................................................. 4
2. Absolute Maximum Ratings..................................................................................................................5
3. Electrical Characteristics......................................................................................................................5
3.1 DC Characteristics..........................................................................................................................5
4. Function Specifications........................................................................................................................ 6
4.1 Basic Operation Function Descriptions..........................................................................................6
4.2 Quick Start Guide........................................................................................................................... 7
5. Command Descriptions.........................................................................................................................7
6. Optical Characteristics..........................................................................................................................8
7. LCD Module Design and Handling Precautions...............................................................................10
8. Case With Brackets Mounting ( 卡扣式安装 )......................................................................................11
Warranty....................................................................................................................................................12
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 2 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
1. Basic Specification
TOPWAY HKT101BTA-C is a Smart TFT Module with 32bit MCU on board. Its graphics engine
provides numbers of outstanding features. It supports TOPWAY SGTools for preload and pre-design
display interface that simplifies the host operation and development time. Suitable for industry control,
instrumentation, medical electronics, power electric equipment applications.
1.1 General Specification
Screen Size(Diagonal) :
10.1”
Resolution :
1024(RGB) x 600
Color Depth :
65k color (16bit)
Pixel Configuration :
RGB Stripe
Display Mode :
Transmissive / Normal Black
Viewing Direction :
6H (*1) (gray-scale inverse)
12H (*2)
Outline Dimension :
271 x 190x 40 (mm)
(see attached drawing for details)
Active Area :
222.72 x 125.28(mm)
Backlight :
LED
Command VF :
RS-232C
Proiect Download :
by PC or by U-Drive (with OTG cable)
Surface Treatment :
Anti-Glare Treatment
Touch Panel:
Resistive Touch Panel
Operating Temperature :
-20 ~ +70°C
Storage Temperature :
-30 ~ +80°C
Highlight :
RTC with battery, Support 90 degrees rotation,
Lua script engine, Buzzer 256MB Flash
Note:
*1. For saturated color display content (eg. pure-red, pure-green, pure-blue, or pure-colors-combinations).
*2. For “color scales” display content.
*3. Color tone may slightly change by Temperature and Driving Condition.
1.2 Block Diagram
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 3 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
1.3 Terminal Function
1.3.1 UART Interface Terminal (K3)
Pin No.
Pin Name
I/O Descriptions
1,
VDD
P
Power supply
2
RX
I
Data Input
3
TX
O
Data output
4
RTS(BUSY)
O
Request To Send (function as busy BUSY signal)
1 ： Busy ； 0 ： No busy
5
NC
NC
No connection
6
VSS
P
Ground, (0V)
Note.
*1. User data and commands transfer through this terminal
*2. HW hand shake is suggested
1.3.2 USB TYPE-C Interface Terminal (K2)
Pin No.
Pin Name
IO
Descriptions
A1/B12
VSS
Power Power Supply GND (0V)
A4/B9
VBUS
Power Positive Power Supply(5.0V)
A5/B5
ID
I
USB_ID,1:Client , 0:HOST
A6/B6
D+
I/O USB D+ Signal
A7/B7
D-
I/O USB D- Signal
A8/B8
NC
-
No connection
B4/A9
VBUS
Power Positive Power Supply(5.0V)
A12/B1
VSS
Power Power Supply GND (0V)
Note.
*1. XML files and image files preload through this terminal.
*2. Do NOT connect USB TYPE-C terminal ,while VDD(K3) is present.
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 4 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
2. Absolute Maximum Ratings
Items
Symbol
Min.
Max.
Unit
Condition
Power Supply voltage
V DD
-0.3
26
V
Operating Temperature
T OP
-20
70
 C
No Condensation
Storage Temperature
T ST
-30
80
 C
No Condensation
Note:
*1. This rating applies to all parts of the module and should not be exceeded.
*2. The operating temperature only guarantees operation of the circuit. The contrast, response speed,
and the other specification related to electro-optical display quality is determined at the room temperature, T OP =25 ℃
*3. Ambient temperature when the backlight is lit (reference value)
*4. Any stresses exceeding the Absolute Maximum Ratings may cause substantial damage to the device. Using the
display under conditions beyond those listed is not advised, which will affect device’s reliability.
3. Electrical Characteristics
3.1 DC Characteristics
VDD=12V,GND=0V, T OP =25  C
Items
Symbol
MIN.
TYP.
MAX.
Unit
Applicable Pin
Operating Voltage
V DD
11
12.0
26
V
VDD
RxD Input MARK(1)
V RxDM
-3.0
-
-15.0
V
Rx
RxD Input SPACE(0)
V RXDS
+3.0
-
+15.0
V
Rx
TxD Output MARK(1)
V TXDM
-3.0
-
-15.0
V
Tx
TxD Output SPACE(0)
V TXDS
+3.0
-
+15.0
V
Tx
RTS Output High
V TXDH
-3.0
-
-15.0
V
RTS(BUSY)
RTS Output Low
V TXDL
+3.0
-
+15.0
V
RTS(BUSY)
Operating Current
I DD
-
350
-
mA
VDD (*1)
Battery Supply Current
I BAT
-
0.6
-
uA
Note.
*1. Normal display condition and no usb connect.
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 5 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
4. Function Specifications
4.1 Basic Operation Function Descriptions
HKT101BTA-C
- XML files, Picture files, ICON files are stored inside FLASH memory area.
- They are preloaded to HKT101BTA-C for stand alone interface use.
- Those files are preloaded via USB interface as an USB drive.
- All the interface flow and the touch response are based on the preloaded XML files
- VP variables memory is inside RAM area,
- it provides real time access via UART by the HOST or display onto the TFT by XML file.
- Custom Memories are inside FLASH memory area
- It can be accessed via UART interface by the HOST.
- Control and Draw Engine executes HOST commands and response respectively
- It also reports the real time Touch Key number to the HOST
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 6 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
4.2 Quick Start Guide
1.
Install TOPWAY
Graphics Editor
Import pictures
2. design UI flow
3.
Download to
Smart LCD
4.
power on &
display
Connect to
5.
host Show
real time
data
5. Command Descriptions
Please refer to “SMART LCD Command Manual” .
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 7 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
6. Optical Characteristics
Item
Symbol Condition
Min
Typ
Max
Unit
Remark
θT
65
75
-
View Angles
θB
CR ≧ 10
70
80
-
Degree Note2,3
θL
70
80
-
θR
70
80
-
Contrast Ratio
CR
θ =0 °
400
500
-
Note 3
T ON
-
16
28
Response Time
25 ℃
ms
Note 4
T OFF
x
0.263
0.313
0363
White
Note 1,5
y
0.267
0.329
0.379
x
0.524
0.574
0.624
Red
Note 1,5
Chromaticity
Backlight is
y
0.285
0.335
0.385
x
on
0.280
0.330
0.380
Green
Note 1,5
y
0.525
0.575
0.625
x
0.108
0.158
0.208
Blue
Note 1,5
y
0.090
0.140
0.190
Uniformity
U
70
80
-
%
Note 6
NTSC
-
47
-
%
Note 5
Luminance
L
-
250
-
cd/ ㎡ Note 7
1. IF= 20 mA, and the ambient temperature is 25 ℃ .
2. The test systems refer to Note 1 and Note 2.
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 8 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
Note 1:
Note 2:
The data are measured after LEDs are turned on for 5
The definition of viewing angle:
minutes. LCM displays full white. The brightness is the
Refer to the graph below marked by θ and Ф
average value of 9 measured spots. Measurement
equipment SR-3A (1°)
Measuring condition:
- Measuring surroundings: Dark room
- Measuring temperature: Ta=25 ℃ .
- Adjust operating voltage to get optimum contrast
at the center of the display.
Note 3:
Note 4:
The definition of contrast ratio (Test LCM using SR-3A (1°)) : Definition of Response time. (Test LCD using BM-7A(2°)):
Luminance When LCD is at “White”
The output signals of photo detector are measured
Contrast
state
when the input signals are changed from
Ratio(CR)
=
Luminance When LCD is at “Black”
“black” to “white”(falling time)
state
and from “white” to “black”(rising time), respectively.
(Contrast Ratio is measured in optimum common electrode
The response time is defined as
voltage)
the time interval between the 10% and 90% of amplitudes.Refer to
figure as below.
Note 5:
Note 6:
Definition of Color of CIE1931 Coordinate and NTSC Ratio.
The luminance uniformity is calculated by using following formula.
△ Bp = Bp (Min.) / Bp (Max.)×100 (%)
Color gamut:
Bp (Max.) = Maximum brightness in 9 measured spots
Area of RGB triangle
S=
X100%
Bp (Min.) = Minimum brightness in 9 measured spots .
Area of NTSC triangle
Note 7:
Measured the luminance of white state at center point
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 9 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
7. LCD Module Design and
7. 液晶显示模块设计和使用须知
Handling Precautions
- Please ensure V0, VCOM is adjustable, to enable LCD module get - 请注意 V0, VCOM 的设定, 以确保液晶显示模块在不同
the best contrast ratio under different temperatures, view angles
的使用温度下以及在不同的视角和位置观察模块显
and positions.
示，均能达到最佳对比度，请务必将应用电路上设置
为对比度可调。
- Normally display quality should be judged under the best contrast - 请注意液晶显示模块的显示品质判定是指在正常对比
ratio within viewable area. Unexpected display pattern may com out
度下以及视窗(V.A)范围内进行的，非正常对比度下液
under abnormal contrast ratio.
晶可能会出现非预期的显示不良，应注意区分。
- Never operate the LCD module exceed the absolute maximum - 请勿在最大额定值以外使用液晶显示模块。
ratings.
- Never apply signal to the LCD module without power supply.
- 请勿在没有接通电源的条件下，给液晶显示模块输送
信号。
- Keep signal line as short as possible to reduce external noise - 请尽可能缩短信号线的连接，以避免对液晶显示模块
interference.
的信号干扰。
- IC chip (e.g. TAB or COG) is sensitive to light. Strong light might - 集成电路因 IC 芯片(如 TAB 或 COG)对紫外线极为敏
cause malfunction. Light sealing structure casing is recommended.
感，强光环境下可能会引起液晶显示模块功能失效，
故应采用不透光的外壳。
- Make sure there is enough space (with cushion) between case and - 请在液晶显示模块与外壳之间保留足够的空间(可使用
LCD panel, to prevent external force passed on to the panel;
衬垫)，以缓冲外力对液晶显示模块的损坏或因受力不
otherwise that may cause damage to the LCD and degrade its
均而产生的显示不匀等异常现象。
display result.
- Avoid showing a display pattern on screen for a long time - 避免液晶显示屏在某一画面下长时间点亮，否则有出
(continuous ON segment).
现残影的风险；请通过软件每隔一段时间改变一次画
面。
- LCD module reliability may be reduced by temperature shock.
- 液晶显示模块的可靠性可能因温度冲击而降低。
- When storing and operating LCD module, avoids exposure to direct - 请勿在阳光直射、高湿、高温或低温下储存和使用液
sunlight, high humidity, high or low temperature. They may damage
晶显示模块，这将造成液晶显示模块的损坏或失效。
or degrade the LCD module.
- Never leave LCD module in extreme condition (max./min - 请勿在极限环境(最大/最小存储/工作温度)下使用或
storage/operate temperature) for more than 48hr.
放置液晶显示模块超过 48 小时以上。
- Recommend LCD module storage conditions is 0 C~40 C - 液晶显示模块建议存储条件为: 0 C~40 C <80%RH 。
<80%RH.
- LCD module should be stored in the room without acid, alkali and - 请勿让液晶显示模块存储于带有 酸性, 碱性, 有害气
harmful gas.
体环境之中。
- Avoid dropping & violent shocking during transportation, and no - 在运输过程中, 请勿让液晶显示模块跌落与猛烈震动,
excessive pressure press, moisture and sunlight.
同时避免 异常挤压, 高湿度, 与阳光照射.
- LCD module can be easily damaged by static electricity. Please - 液晶显示模块极易受静电损坏，请务必保证液晶显示
maintain an optimum anti-static working environment to protect the
模块在防静电的工作环境中使用或保存。(如: 烙铁正
LCD module. (eg. ground the soldering irons properly)
确接地,等)
- Be sure to ground the body when handling LCD module.
- 拿取液晶显示模块时需注意操作人员的接地情况。
- Only hold LCD module by its sides. Never hold LCD module by - 请手持液晶显示模块的边沿取放模块，防止热压纸或
applying force on the heat seal or TAB.
TAB 部位受力。
- When soldering, control the temperature and duration avoid - 焊接液晶模块时，请注意控制烙铁的温度、焊接时
damaging the backlight guide or diffuser which might degrade the
间，以免烫坏导光板或偏光片，导致显示不匀等不良
display result such as uneven display.
现象发生。
- Never let LCD module contact with corrosive liquids, which might - 请勿使用洗板水等腐蚀性液体接触液晶模块，以免腐
cause damage to the backlight guide or the electric circuit of LCD
蚀导光板或模块电路。
module.
- Only clean LCD with a soft dry cloth, Isopropyl Alcohol or Ethyl - 仅可使用柔软的干布, 异丙醇或乙醇清洁液晶屏表
Alcohol. Other solvents (e.g. water) may damage the LCD.
面，其他任何溶剂(如:水)都有可能损坏液晶模块。
- Never add force to components of LCD module. It may cause - 请勿挤压液晶显示模块上的元器件，以避免产生潜在
invisible damage or degrade the module's reliability.
的损坏或失效而影响产品可靠性。
- When mounting LCD module, please make sure it is free from - 装配液晶显示模块时，请务必注意避免液晶显示模块
twisting, warping and bending.
的扭曲或变形。
- Do not add excessive force on surface of LCD, which may cause - 请勿挤压液晶显示屏表面，这将导致显示颜色的异
the display color change abnormally.
常。
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 10 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
- LCD panel is made with glass. Any mechanical shock (e.g. - 液晶屏由玻璃制作而成，任何机械碰撞(如从高处跌
dropping from high place) will damage the LCD module.
落)均有可能损坏液晶显示模块。
- Protective film is attached on LCD screen. Be careful when peeling - 液晶屏表面带有保护膜, 揭除保护膜时需要注意可能
off this protective film, since static electricity may be generated.
产生的静电。
- Polarizer on LCD gets scratched easily. If possible, do not remove - 因液晶显示屏表面的偏光片极易划伤，安装完成之前
LCD protective film until the last step of installation.
请尽量不要揭下保护膜。
- When peeling off protective film from LCD, static charge may cause - 请缓慢揭除保护膜，在此过程中液晶显示屏上可能会
abnormal display pattern. The symptom is normal, and it will turn
产生静电线，此为正常情况，可在短时间内消失。
back to normal in a short while.
- LCD panel has sharp edges, please handle with care.
- 请注意避免被液晶显示屏的边缘割伤。
- Never attempt to disassemble or rework LCD module.
- 请不要试图拆卸或改造液晶显示模块。
- If display panel is damaged and liquid crystal substance leaks out, - 当液晶显示屏出现破裂, 内部液晶液体可能流出; 相
be sure not to get any in your mouth, if the substance comes into
关液体不可吞吃, 绝对不可接触嘴巴, 如接触到皮肤
contact with your skin or clothes promptly wash it off using soap
或衣服, 请使用肥皂与清水彻底清洗.
and water.
8. Case With Brackets Mounting ( 卡扣式安装 )
Front Mounting
前装产品
- Application panel opening:The suggested assemble gap should be - 应用面板开窗尺寸：建议每边安装间隙约 0.5~0.8mm
about 0.5~0.8mm on each side.
- Install the TFT module on strong flat surface for securing water and - 面板开窗部分要有足够的刚度和良好的平整度，以利安
sealing.
装及密封防水 .
- A silicon sealing ring ships with display module. It should be in
- 显示模块上的硅胶密封圈在安装时确保嵌入到位
place before assembling to the front panel.
- Pre-fixing: Slightly tighten the screws on beam clamp in sequence - 预紧：将卡扣螺钉按图示顺序稍加预紧 .
as picture on the right side.
- IFinal-fixing: Tighten the fixing screws on beam clamp in sequence - 紧固 : 再次按顺序用 0.3-0.5 N.m 扭力拧紧卡扣螺钉并 注意
as well with twist torque about 0.3-0.5N.m and put the beam clamp
卡扣置正无歪斜 .
straight.
Model/ 型号
A
B
R
T
HKT101BTA-C
258mm
177mm
1.0mm
0.3-0.5 N.m
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 11 of 12
TOPWAY
LCD Module User Manual
HKT101BTA-C
Warranty
This product has been manufactured to our company’s specifications as a part for use in your company’s general
electronic products. It is guaranteed to perform according to delivery specifications. For any other use apart from
general electronic equipment, we cannot take responsibility if the product is used in medical devices, nuclear power
control equipment, aerospace equipment, fire and security systems, or any other applications in which there is a direct
risk to human life and where extremely high levels of reliability are required. If the product is to be used in any of the
above applications, we will need to enter into a separate product liability agreement.
- We cannot accept responsibility for any defect, which may arise form additional manufacturing of the product
(including disassembly and reassembly), after product delivery.
- We cannot accept responsibility for any defect, which may arise after the application of strong external force to the
product.
- We cannot accept responsibility for any defect, which may arise due to the application of static electricity after the
product has passed our company’s acceptance inspection procedures.
- We cannot accept responsibility for intellectual property of a third part, which may arise through the application of
our product to our assembly with exception to those issues relating directly to the structure or method of
manufacturing of our product.
URL: www.topwaydisplay.com
Document Name: HKT101BTA-C-Manual-Rev0.2.doc
Page: 12 of 12
SMART LCD
Command V5.04
Manual
Prepared by:
Checked by:
Approved by:
liu
Date: 2017-07-24
Date:
Date:
Rev.
Descriptions
Release Date
0.1
- Preliminary Draft release
2016-11-02
0.2
- Add a description of the 0xE8 command
2017-01-12
0.3
- 4.1, 0xE2, 0xE3 command name correction
2017-05-26
0.4
- Add a description of the 0xE7 command
2017-07-24
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 1 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
Table of Content
1
Basic Specifications ................................................................................................................................... 3
1.1
Hardware connection ............................................................................................................................ 3
2
Command Structure ................................................................................................................................... 3
2.1
Communication Packet Structure ......................................................................................................... 3
2.2
Packet Acknowledgment ...................................................................................................................... 3
3
Data arrangement ....................................................................................................................................... 4
3.1
Color Data Value Configuration ............................................................................................................ 4
3.2
Data / Address / Page_ID / Location Values Configuration .................................................................. 4
4
Command Descriptions ............................................................................................................................. 5
4.1
Command table .................................................................................................................................... 5
4.2
Config/ Status Function Commands Details ......................................................................................... 6
4.2.1
hand_shake ( 0x30 ) ..................................................................................................................... 6
4.2.2
read_version ( 0x31 ) .................................................................................................................... 6
4.2.3
read_pg_id ( 0x32 ) ....................................................................................................................... 7
4.2.4
touch_response ( 0x72/ 0x73/ 0x77/ 0x78/ 0x79 ) ........................................................................ 7
4.2.5
set_sys_config ( 0xE0 ) ................................................................................................................. 8
4.2.6
sel_project ( 0xE1 ) ....................................................................................................................... 9
4.2.7
touch_calib ( 0xE4 ) ...................................................................................................................... 9
4.2.8
screen_saver (0x5E) ..................................................................................................................... 9
4.2.9
backlight_ctrl ( 0x5F ) .................................................................................................................... 9
4.2.10
buzzer_touch_sound ( 0x79 ) ....................................................................................................... 9
4.2.11
buzzer_ ctrl ( 0x7A ) ...................................................................................................................... 9
4.2.12
Flash_write ( 0x90 ) .................................................................................................................... 10
4.2.13
Flash_read ( 0x91 ) ..................................................................................................................... 10
4.2.14
RTC_read ( 0x9B ) ...................................................................................................................... 10
4.2.15
RTC_set ( 0x9C ) ........................................................................................................................ 11
4.2.16
USR_bin_read ( 0x93 ) ............................................................................................................... 11
4.2.17
U_drv_format ( 0xE2 ) ................................................................................................................ 11
4.2.18
U_drv_unlock ( 0xE3 ) ................................................................................................................ 11
4.3
Display Control Function Commands Details ..................................................................................... 12
4.3.1
disp_page ( 0x70 ) ...................................................................................................................... 12
4.3.2
set_element_fg ( 0x7E ) .............................................................................................................. 12
4.3.3
set_element_bg ( 0x7F ) ............................................................................................................. 12
4.3.4
Set_codepage (0xE7) ................................................................................................................. 12
4.3.5
suspend_vp_refresh (0xE8) ........................................................................................................ 13
4.4
VP Function Commands Details ......................................................................................................... 13
4.4.1
Successive_write ( 0x82 ) ........................................................................................................... 13
4.4.2
Successive_read ( 0x83 ) ........................................................................................................... 13
4.4.3
BP1_write ( 0x4B ) ...................................................................................................................... 14
4.4.4
BP1_write_compress ( 0x4C ) .................................................................................................... 14
4.4.5
G16_write ( 0x4D ) ...................................................................................................................... 15
4.4.6
G16_write_rotate ( 0x4E ) ........................................................................................................... 15
4.4.7
System Register Write ( 0x3B ) ................................................................................................... 15
4.4.8
System Register Read ( 0x3C ) .................................................................................................. 16
4.4.9
STR_write ( 0x42 ) ...................................................................................................................... 16
4.4.10
STR_read ( 0x43 ) ...................................................................................................................... 16
4.4.11
STR_fill ( 0x46 ) .......................................................................................................................... 17
4.4.12
N16_write ( 0x3D ) ...................................................................................................................... 17
4.4.13
N16_read ( 0x3E ) ...................................................................................................................... 17
4.4.14
N16_fill ( 0x3F )........................................................................................................................... 17
4.4.15
N32_write ( 0x44 ) ...................................................................................................................... 18
4.4.16
N32_read ( 0x45 ) ....................................................................................................................... 18
4.4.17
N32_fill ( 0x47 ) ........................................................................................................................... 18
4.4.18
N64_write ( 0x48 ) ...................................................................................................................... 19
4.4.19
N64_read ( 0x49 ) ....................................................................................................................... 19
4.4.20
N64_fill ( 0x4A ) .......................................................................................................................... 19
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 2 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
1 Basic Specifications
TOPWAY Smart LCD serial command is for real-time control and access. Host machine get the data
which input through the Smart LCD interface or provide the data for display.
1.1 Hardware connection
Smart LCD serial UART interface are mainly base on RS232-C standard, by default, config as 8N1
115200bps.
2 Command Structure
2.1 Communication Packet Structure
Commands and Response Packet should be format as follow (host  module):
Seq
Code
Code type
Description
1
0xAA
Packet header
1byte
2
Cmd-code
Command
1byte
code
3
Par-data
Parameter or
(*1)
Data
:
:
-
-
:
:
-
-
:
:
-
-
N-3 th
0xCC
Packet tail
4byte
N-2 th
0x33
N-1 th
0xC3
N th
0x3C
Note.
*1. Unless otherwise specified,
all the multi- byte values, data, address’ byte sequence are MSB first, LSB last.
2.2 Packet Acknowledgment
Packet Acknowledgment is two byte in ASCII (module  host):
Response
code Description
Command (in packet) executed and
":>"
In ASCII
wait for next Command
(0x3a, 0x3e)
Command (in packet) error and
"!>"
In ASCII
wait for next Command
(0x21,0x3e)
15B15B15B15B
Note.
*1. Packet Acknowledgement response to a valid packet only.
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 3 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
3 Data arrangement
3.1 Color Data Value Configuration
16 bit Color value
16 bit color value
R4
R3
R2
R1
R0
G5
G4
G3
G2
G1
G0
B4
B3
B2
B1
B0
High byte (MSB)
Low byte (LSB)
D7
D6
D5
D4
D3
D2
D1
D0
D7
D6
D5
D4
D3
D2
D1
D0
3.2 Data / Address / Page_ID / Location Values Configuration
64bit value
64 bit number value
D63…D56 D55…D48 D47…D40 D39..D32 D31…D24 D23…D16 D15…D8 D7…D0
Byte7
Byte0
(MSB)
(LSB)
D7…D0
D7…D0
D7…D0
D7…D0
D7…D0
D7…D0
D7…D0
D7…D0
32bit value
32 bit number value
D31…D24
D23…D16
D15…D8
D7…D0
Byte3 (MSB)
Byte0 (LSB)
D7…D0
D7…D0
D7…D0
D7…D0
16bit value
16 bit number value
D15…D8
D7…D0
High Byte (MSB)
Low Byte (LSB)
D7…D0
D7…D0
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 4 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4 Command Descriptions
4.1 Command table
Functions
Name
Code
Description
Config/
hand_shake
0x30
Read a Hand Shake
Status
read_version
0x31
Read firmware version
Functions
read_pg_id
0x32
Read Current page ID
touch_response
0x72/0x73/
see also set_sys_config
0x77/0x78/
0x79
set_sys_config
0xE0
System parameter configuration and Baud Rate
sel_project
0xE1
Specify operating project folder
touch_calib
0xE4
Touch panel calibration
screen_saver
0x5E
Screen saver (backlight dim down time out)
backlight_ctrl
0x5F
backlight brightness control (64 levels)
buzzer_touch_sound
0x79
buzzer enable time length (in 10ms step)
buzzer_ctrl
0x7A
Buzzer control
Flash_write
0x90
Write data to the flash
Flash_read
0x91
Read data from the flash
RTC_read
0x9B
Read the RTC values
RTC_set
0x9C
Set the RTC
USR_bin_read
0x93
Read data from the USR_bin
U_drv_format
0xE2
Format the U_drv
U_drv_unlock
0xE3
Unlock the U_drv with pre-stored password
Display
disp_page
0x70
Display a pre-stored TML file (page)
Control
set_element_fg
0x7E
Set the foreground color of STR, N16, N32 or N64
Functions
set_element_bg
0x7F
Set the background color of STR, N16, N32 or N64
set_codepage
0xE7
Sets country character set and code-page character set
suspend_vp_fresh
0xE8
Set the screen to pause the refresh and deactivate the
touchkey or release the pause to refresh and enable
the touchkey
VP
Successive_write
0x82
Write successive value to VP_N16, VP_N32, VP_N64
Functions
Successive_read
0x83
Read successive value from VP_N16, VP_N32, VP_N64
BP1_write
0x4B
Write bit-map (1bpp) data to VP_BP1
BP1_write_comp
0x4C
Write compressed bit-map (1bpp) data to VP_BP1
G16_write
0x4D
Write 16bit (signed integer) graphic array to VP_G16
G16_write_rotate
0x4E
Rotate the VP_G16 array data inside the module and
write a 16bit (signed integer) value into end-of-array
System Register Write
0x3B
Write System Register
System Register Read
0x3C
Read System Register
STR_write
0x42
Write string to VP_STR
STR_read
0x43
Read string form VP_STR
STR_fill
0x46
Fill strings to the VP_STR
N16_write
0x3d
Write 16bit (signed integer) value to VP_N16
N16_read
0x3e
Read 16bit (signed integer) value from VP_N16
N16_fill
0x3f
Fill numbers to the VP_N16
N32_write
0x44
Write 32bit (signed integer) value to VP_N32
N32_read
0x45
Read 32bit (signed integer) value from VP_N32
N32_fill
0x47
Fill numbers to the VP_N32
N64_write
0x48
Write 64bit (signed integer) value to VP_N64
N64_read
0x49
Read 64bit (signed integer) value from VP_N64
N64_fill
0x4A
Fill numbers to the VP_N64
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 5 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.2 Config/ Status Function Commands Details
4.2.1 hand_shake ( 0x30 )
seq
Cmd-code / Par-data
Descriptions
1
0x30
Read a Hand Shake
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x30
Command executed
3 rd
“T”
0x54
“Topway HMT Ready \ 0” in ASCII
4 th
“o”
0x6f
5 th
“P”
0x70
6 th
“w”
0x77
7 th
“a”
0x61
8 th
“y”
0x79
9 th
“ “
0x20
10 th
“H”
0x48
11 th
“M”
0x4d
12 th
“T”
0x54
13 th
“ “
0x20
14 th
“R”
0x52
15 th
“e”
0x65
16 th
“a”
0x61
17 th
“d”
0x64
18 th
“y”
0x79
‘ \0 ’(0x00): string end mark
19 th
\0
0x00
20 th
Tail
0xCC
Communication packet tail
21 st
0x33
22 nd
0xC3
23 rd
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
4.2.2 read_version ( 0x31 )
Seq
Cmd-code / Par-data
Descriptions
1
0x31
Read firmware version
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x31
Command executed
3 rd
“1”
0x31
“1.06 \ 0” in ASCII
4 th
“.”
0x2e
Where firmware version is V1.06(example)
5 th
“0”
0x30
6 th
“ 6 ”
0x36
7 th
\0
0x00
‘ \0 ’(0x00): string end mark
8 th
Tail
0xCC
Communication packet tail
9 th
0x33
10 th
0xC3
11 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 6 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.2.3 read_pg_id ( 0x32 )
Seq
Cmd-code / Par-data
Descriptions
1
0x32
Read Current page ID
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x32
Command executed
3 rd
Page ID
Page_IDh
Current Page ID in 16bit binary value
4 th
Page_IDl
5 th
Tail
0xCC
Communication packet tail
6 th
0x33
7 th
0xC3
8 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
4.2.4 touch_response ( 0x72/ 0x73/ 0x77/ 0x78/ 0x79 )
seq
Cmd-code / Par-data
Descriptions
1
--
Use set_sys_config to config the functions
Touch Release Coordinate Response code (0x72):
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x72
Touched release Coordinate
3 rd
X coordinate
Xh
Coordinate in 16bit binary value
4 th
Xl
X = horizontal coordinate
5 th
Y coordinate
Yh
Y = vertical coordinate
6 th
Yl
7 th
Tail
0xCC
Communication packet tail
8 th
0x33
9 th
0xC3
10 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
Touch Down Coordinate Response code ( 0x73 ):
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x73
Touched down Coordinate
3 rd
X coordinate
Xh
Coordinate in 16bit binary value
4 th
Xl
X = horizontal coordinate
5 th
Y coordinate
Yh
Y = vertical coordinate
6 th
Yl
7 th
Tail
0xCC
Communication packet tail
8 th
0x33
9 th
0xC3
10 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
Touch Key ID Response code ( 0x78 ):
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x78
Touched release Key_ID defined by TOPWAY TML Graphic
Editor will be response to host
3 rd
Page_ID
Page_IDh
Page_ID = the touch key in page(16bit binary value)
4 th
Page_IDl
5 th
Y coordinate
Key_ID
Key_ID (8bit binary value)
6 th
Tail
0xCC
Communication packet tail
7 th
0x33
8 th
0xC3
9 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 7 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
Touch Key ID Response code ( 0x79 ):
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x79
Touched down Key_ID defined by TOPWAY TML Graphic
Editor will be response to host
3 rd
Page_ID
Page_IDh
Page_ID = the touch key in page(16bit binary value)
4 th
Page_IDl
5 th
Y coordinate
Key_ID
Key_ID (8bit binary value)
6 th
Tail
0xCC
Communication packet tail
7 th
0x33
8 th
0xC3
9 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
Touch Key VP_ADD+VP_Value Response code ( 0x77 ):
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x77
Touch Key VP_ADD+VP_Value Response code
3 rd
VP_ADD
Addr3 （ MSB ） VP Address
4 th
Addr2
0x080000 ~ 0x08FFFF:VP_N16 Address
5 th
Addr1
0x020000 ~ 0x02FFFF:VP_N32 Address
6 th
Addr0(LSB)
0x030000 ~ 0x03FFFF:VP_N64 Address
0x000000 ~ 0x01FFFF:VP_STR Address
7 th
Data
:
No.of byte
:
:
VP_N16: 2byte
:
VP_N32: 4byte
:
VP_N64: 8byte
:
:
VP_STR: string (with end mark ( ‘‘ \0 ’(0x00) ))
:
Tail
0xCC
Communication packet tail
:
0x33
:
0xC3
:
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
4.2.5 set_sys_config ( 0xE0 )
seq
Cmd-code / Par-data
Descriptions
1
0xE0
Baud Rate and system parameter configuration
2
0x55
3
0xAA
4
0x5A
5
0xA5
6
Baud_Set
Baudrate Set:
0x00 = 1200bps
0x01 = 2400bps
0x02 = 4800bps
0x03 = 9600bps
0x04 = 19200bps
0x05 = 38400bps
0x06 = 57600bps
0x07 = 115200bps
7
sys_par1
Bit7 = 0: Touch panel function disable
Bit7 = 1: Touch panel functions enable (*3)(default)
Bit[1..0]: Touch actions configuration (*2, *3)
8
0x00
Reserved
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. Touch panel configuration:
Sys_par1
Sys_par1
Sys_par1
Response
Bit7
Bit1
Bit0
To host
Descriptions
0
0
0
Null
Not touch panel functions
1
0
1
Coordinates
Touch down Coordinate will be response to host
1
1
0
Coordinates
Touch release Coordinate will be response to host
1
1
1
Key ID
Touch Key_ID defined by TOPWAY TML Graphic Editor will be
response to host
*3. see set_touch section for response code
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 8 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.2.6 sel_project ( 0xE1 )
seq
Cmd-code / Par-data
Descriptions
1
0xE1
Select project folder
2
Prj_ID
0~9, project ID
0: System execute the default project “ THMT ”
1~9: System execute the project “ THMT01 ” ~ “ THMT09 ”
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.2.7 touch_calib ( 0xE4 )
seq
Cmd-code / Par-data
Descriptions
1
0xE4
Touch panel calibration
2
0x55
3
0xAA
4
0x5A
5
0xA5
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. Keep pressing the touch panel during power on, could also trigger the touch_calib function
4.2.8 screen_saver (0x5E)
seq
Cmd-code / Par-data
Descriptions
1
0x5E
Screen saver
2
Time1h
time out time in seconds, range: 0x0000 ~ 0xffff
3
Time1l
(0x0000: disable screen saver function) (*2)
4
PWM_LE
PWM_LE = 0 ~ 0x3F (default 0x19 in dim down),
the backlight dimmed level in screen saving mode (*2)
Screensavers brightness can not be greater than the backlight
brightness.
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. default value defined by TML graphic editor configuration
4.2.9 backlight_ctrl ( 0x5F )
seq
Cmd-code / Par-data
Descriptions
1
0x5F
backlight brightness control
2
PWM_LE
PWM_LE=0x00 ~ 0x3F (*2)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. default value defined by TML graphic editor configuration
4.2.10 buzzer_touch_sound ( 0x79 )
seq
Cmd-code / Par-data
Descriptions
1
0x79
buzzer touch sound control
2
Time
Sounding time length (in 10ms), range 0x00~0x3F
0x00= disable (*2)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. default value defined by TML graphic editor configuration
4.2.11 buzzer_ ctrl ( 0x7A )
seq
Cmd-code / Par-data
Descriptions
1
0x7A
Buzzer control
2
Loop count
Loop count, Range: 0x01 ~ 0xFF.
0xFF = buzzer infinite loop
3
T1
Buzzer play time 1
Range: 0x00 ~ 0xFF (0~25.5s)(unit 100ms)
4
T2
Buzzer play time 2
Range: 0x00 ~ 0xFF (0~25.5s)(unit 100ms)
5
Freq1
T1 time Buzzer frequency, Unit 100 Hz
Ranges: 0x05 ~ 0x32 (500Hz ~ 5KHz)
0x00 = T1 time period buzzer turn off
6
Freq2
T2 time Buzzer frequency, Unit 100 Hz
Ranges: 0x05 ~ 0x32 (500Hz ~ 5KHz)
0x00 = T1 time period buzzer turn off
Note:
1. The buzzer sound time is (T1 + T2)*100ms
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 9 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.2.12 Flash_write ( 0x90 )
seq
Cmd-code / Par-data
Descriptions
1
0x90
Write data to the flash at specified address
2
Address3(MSB)
the specified start address to write
3
Address2
Address range =0x00000 ~ 0x03FFFF
4
Address1
5
Address0(LSB)
6
Data_Lengthh
The no. of data byte to write.
7
Data_Lengthl
Length =0x0001 ~ 0x0400
8
Data
data to write.
:
:
:
:
:
:
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.2.13 Flash_read ( 0x91 )
seq
Cmd-code / Par-data
Descriptions
1
0x91
Read data from the flash at specified address
2
Address3(MSB)
the specified start address to write
3
Address2
Address range =0x00000 ~ 0x03FFFF
4
Address1
5
Address0(LSB)
6
Data_Lengthh
The no. of data byte to read
7
Data_Lengthl
Length =0x0001 ~ 0x0400
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x91
Command executed
3 rd
Data
data
Read back data
:
:
:
:
:
Tail
0xCC
Communication packet tail
:
0x33
:
0xC3
:
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
4.2.14 RTC_read ( 0x9B )
seq
Cmd-code / Par-data
Descriptions
1
0x9B
Read the current RTC value
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x9B
Command executed
3 rd
Date
Year
Year: 00~99 (00=year 2000) (8bit binary value)
4 th
Month
Month: 01~12 (8bit binary value)
5 th
Day
Day: 01~31 (8bit binary value)
6 th
Time
Hour
Hour 00~23 (24hr format)(8bit binary value)
7 th
Minute
Minutes 00~59 (8bit binary value)
8 th
Second
Second 00~59 (8bit binary value)
9 th
Tail
0xCC
Communication packet tail
10 th
0x33
11 th
0xC3
12 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 10 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.2.15 RTC_set ( 0x9C )
seq
Cmd-code / Par-data
Descriptions
1
0x9C
Set the RTC
2
Year
Year
= 00~99(2000 ~ 2099)
3
Month
Month = 00~12
4
Date
Date
= 00~31
Hour
= 00~23
5
Hour
Minute = 00~59
6
Minute
Second = 00~59
7
Second
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.2.16 USR_bin_read ( 0x93 )
seq
Cmd-code / Par-data
Descriptions
1
0x93
Read USR_bin data from the flash at specified address
2
Address3(MSB)
the specified start address to write
3
Address2
Address range = 0x00000 ~ 0x03FFFF
4
Address1
5
Address0(LSB)
6
Data_Lengthh
The no. of data byte to read
7
Data_Lengthl
Length = 0x0001 ~ 0x0400
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x93
Command executed
3 rd
Data
data
Read back data
:
:
:
:
:
Tail
0xCC
Communication packet tail
:
0x33
:
0xC3
:
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
4.2.17 U_drv_format ( 0xE2 )
seq
Cmd-code / Par-data
Descriptions
1
0xE2
Format the USB drive.
2
0x55
All the files (include the security lock file) will be erased.
3
0xAA
4
0x5A
5
0xA5
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.2.18 U_drv_unlock ( 0xE3 )
seq
Cmd-code / Par-data
Descriptions
1
0xE3
Unlock the USB drive of file read/write with pre-stored password.
2
PW
PW: password in ASCII
:
:
Length = 127max.
:
:
‘ \0 ’(0x00): string end mark
:
‘ \0 ’
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 11 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.3 Display Control Function Commands Details
4.3.1 disp_page ( 0x70 )
seq
Cmd-code / Par-data
Descriptions
1
0x70
Display a pre-stored TML file(page)
2
Page_IDh
Page_ID = 0~999
3
Page_IDl
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.3.2 set_element_fg ( 0x7E )
Seq
Cmd-code / Par-data
Descriptions
1
0x7E
Set foreground colors of the STR, N16, N32 or N64
2
Element
0x00 = STR; 0x01 = N16, N32, N64
3
Page_IDh
Page_ID = 0~999
4
Page_IDl
5
Element_ID
VP_STR = 0~127; N16, N32, N64 = 0~119
6
0x00
Reserve
7
FGh
Foreground color(0~0xffff)
8
FGl
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.3.3 set_element_bg ( 0x7F )
Seq
Cmd-code / Par-data
Descriptions
1
0x7F
Set background color of the STR, N16, N32 or N64
2
Element
0x00 = STR; 0x01 = N16, N32, N64
3
Page_IDh
Page_ID = 0~999
4
Page_IDl
5
Element_ID
VP_STR = 0~127, N16, N32, N64 = 0~119
6
Mode
0x00: non transparent; 0x01 : transparent
7
BGh
Background color(0 ~ 0xffff)
8
BGl
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.3.4 set_codepage (0xE7)
Seq
Cmd-code / Par-data
Descriptions
1
0xE7
Sets country character set and code-page character set
2
Country
1 ~ 11, country character set
3
Codepage
1 ~ 22, code-page character set
Note.
*1. Country and CodePage table
Country Code
Descriptions
Code Page
Descriptions
1
USA
1
437 (OEM – United States)
2
France
2
737 (OEM – Greek 437G)
3
Germany
3
852 (OEM – Latin II )
4
United Kingdom
4
860 (OEM – Portuguese)
5
Demark I
5
863 (OEM – Canadian French)
6
Demark II
6
865 (OEM – Nordic)
7
Sweden
7
866 (OEM – Russian)
8
Italy
8
874 (ANSI/OEM – Thai)
9
Spain
9
932 (ANSI/OEM – Japanese Shift-JIS)
10
Japan
10
1250 (ANSI - Central Europe)
11
Norway
11
1251 (ANSI – Cyrillic)
--
--
12
1252 (ANSI – Latin I )
--
--
13
1253 (ANSI – Greek)
--
--
14
1254 (ANSI – Turkish)
--
--
15
1255 (ANSI – Hebrew)
--
--
16
1256 (ANSI – Arabic)
--
--
17
1257 (ANSI – Baltic)
--
--
18
1258 (ANSI – Viet Nam)
--
--
19
GB2312
--
--
20
GBK
--
--
21
EUC_KR
--
--
22
Big5
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 12 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.3.5 suspend_vp_refresh (0xE8)
Seq
Cmd-code / Par-data
Descriptions
1
0xE8
Set the screen to pause the refresh and deactivate the touchkey or
2
55
release the pause to refresh and enable the touchkey
3
AA
4
5A
5
A5
6
Mode
0x00: r elease the pause to refresh and enable the touchkey
0x01: pause the refresh and deactivate the touchkey
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.4 VP Function Commands Details
4.4.1 Successive_write ( 0x82 )
Seq
Cmd-code / Par-data
Descriptions
1
0x82
Write successive value to VP_N16, VP_N32, VP_N64
2
Addr3(MSB)
VP_N16 Address = 0x080000 ~ 0x08FFFF (should be aligned every 2
3
Addr2
byte)
4
Addr1
VP_N32 Address = 0x020000 ~ 0x02FFFF (should be aligned every 4
byte)
5
Addr0(LSB)
VP_N64 Address = 0x030000 ~ 0x03FFFF (should be aligned every 8
byte)
6
Length
The number of data to write (Length = 1~255)
7
Data 1(MSB)
the value to write
8
Data 2
No. of byte of Data:
9
Data 3
VP_N16 = Length *2,
VP_N32 = Length *4,
:
:
VP_N64 = Length *8,
:
Data n(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.4.2 Successive_read ( 0x83 )
Seq
Cmd-code / Par-data
Descriptions
1
0x83
Read successive value to VP_N16, VP_N32, VP_N64
2
Addr3(MSB)
VP_N16 Address = 0x080000 ~ 0x08FFFF (should be aligned every 2
3
Addr2
byte)
4
Addr1
VP_N32 Address = 0x020000 ~ 0x02FFFF (should be aligned every 4
byte)
5
Addr0(LSB)
VP_N64 Address = 0x030000 ~ 0x03FFFF (should be aligned every 8
byte)
6
Length
The number of data to write (Length = 1 ~ 255)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x83
Command executed
3 rd
VP_ADD
Addr3(MSB ）
VP Address
4 th
Addr2
0x080000 ~ 0x08FFFF:VP_N16 Address
5 th
Addr1
0x020000 ~ 0x02FFFF:VP_N32 Address
6 th
Addr0(LSB)
0x030000 ~ 0x03FFFF:VP_N64 Address
7 rd
Length
NO.
No. of data
8 rd
Data
Data n(MSB)
No. of byte of Data:
:
:
VP_N16 = Length *2,
:
:
VP_N32 = Length *4,
(n-1) th
Data1
VP_N64 = Length *8,
n th
Data0(LSB)
(n+1) th
Tail
0xCC
Communication packet tail
(n+2) th
0x33
(n+3) th
0xC3
(n+4) th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 13 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.4.3 BP1_write ( 0x4B )
Seq
Cmd-code / Par-data
Descriptions
1
0x4B
Write raw bit-map data to the VP_BP1
2
Addr3(MSB)
VP_BP1 Address = 0x040000 ~ 0x05FFFF
3
Addr2
4
Addr1
5
Addr0(LSB)
6
Length3(MSB)
the number of data
7
Length2
Length = 1 ~ 98304
8
Length1
9
Length0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. After the above command issued, it follow with the raw data byte with out communication packet structure.
*3. over all command flow
HOST
Flow
module
BP1_write Command
Instruct to wait for data….
(in communication packet structure)
Raw 1bpp image data
Store the data into VP_BP1
(without communication packet structure)
Response code “ :> ” in ASCII
(without communication packet structure)
4.4.4 BP1_write_compress ( 0x4C )
Seq
Cmd-code / Par-data
Descriptions
1
0x4C
Write compressed bit-map data to the VP_BP1
2
Addr3(MSB)
VP_BP1 Address = 0x040000 ~ 0x05FFFF
3
Addr2
4
Addr1
5
Addr0(LSB)
6
Length3(MSB)
the number of data
7
Length2
Length = 1 ~ 98304
8
Length1
9
Length0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. After the above command issued, it follow with the compressed data byte with out communication packet structure.
*3. over all command flow
HOST
Flow
module
BP1_write Command
Instruct to wait for data….
(in communication packet structure)
compressed 1bpp image data
Store the data into VP_BP1
(without communication packet structure)
Response code “ :> ” in ASCII
(without communication packet structure)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 14 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.4.5 G16_write ( 0x4D )
Seq
Cmd-code / Par-data
Descriptions
1
0x4D
Write graph values to the VP_G16 array
2
Addr1_H
VP_G16 Address = 0x060000 ~ 0x07FFFF
3
Addr1l
4
Addr2h
5
Addr2l
6
Sizeh
Array-size = 1 ~ 1024
7
Sizel
(*2, *3)
8
Data(MSB)
16 bit data array
9
Data(LSB)
(no. of byte = 2x array-size)
10
Data(MSB)
11
Data(LSB)
:
:
:
:
:
:
:
:
:
:
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. Array-size = no. of 16bit values
*3. Array-size suggest to be same at the size value defined in TML editor
4.4.6 G16_write_rotate ( 0x4E )
Seq
Cmd-code / Par-data
Descriptions
1
0x4E
Write graph values to the last position of VP_G16 array
with rotation effect
2
Addr1_H
VP_G16 Address = 0x060000 ~ 0x07FFFF
3
Addr1_L
4
Addr2_H
5
Addr2_L
6
Size_H
Array-size to be rotate = 1 ~ 65535
7
Size_L
(*2. *3)
8
Data(MSB)
16 bit data value to be add to the end-of-array
9
Data(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
*2. Array-size = no. of 16bit values
*3. Array-size suggest to be same at the value defined in TML editor
4.4.7 System Register Write ( 0x3B )
seq
Cmd-code / Par-data
Descriptions
1
0x3B
System Register Write Command
2
Addr3(MSB)
3
Addr2
Timer_Ctrl0 Address = 0xFFFF00
：
4
Addr1
Timer_Ctrl7 Address = 0xFFFF07
5
Addr0(LSB)
6
Data
the value to write
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 15 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.4.8 System Register Read ( 0x3C )
seq
Cmd-code / Par-data
Descriptions
1
0x3C
System Register Read Command
2
Addr3(MSB)
3
Addr2
Address = 0xFFFF00
：
4
Addr1
Address = 0xFFFFFF
5
Addr0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x3C
Command executed
3 rd
Addr3(MSB)
4 th
Addr2
Address = 0xFFFF00
Address
：
5 th
Addr1
Address = 0xFFFFFF
6 th
Addr0(LSB)
7 th
Data
Data(1Byte)
the value of the register
8 th
0xCC
9 th
0x33
Tail
Communication packet tail
10 th
0xC3
11 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
*2. When Timer reach the 0x00000000 or 0x7FFFFFFF, a notification will be provided a 0x77 response code with the corresponding
Timer Address and Value.(See touch_response(0x77)for details)
4.4.9 STR_write ( 0x42 )
Seq
Cmd-code / Par-data
Descriptions
1
0x42
Write string to VP_STR
2
Addr3(MSB)
the VP_STR Address = 0x00000 ~ 0x01FFFF
3
Addr2
(each VP_STR = 128 bytes)
4
Addr1
(address value must be divisible by 128)
5
Addr0(LSB)
6
data
String to write
:
:
Total no. of byte in string ≤ 128
:
:
:
‘ \0 ’
‘ \0 ’(0x00): string end mark
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.4.10 STR_read ( 0x43 )
Seq
Cmd-code / Par-data
Descriptions
1
0x43
Read string from VP_STR
2
Addr3(MSB)
the VP_STR Address = 0x00000 ~ 0x01FFFF
3
Addr2
(each VP_STR = 128 bytes)
4
Addr1
(address value must be divisible by 128)
5
Addr0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x43
Command executed
3 rd
String data
data
String code
:
:
:
:
:
\0
0x00
‘‘ \0 ’(0x00): string end mark
:
Tail
0xCC
Communication packet tail
:
0x33
:
0xC3
:
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 16 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.4.11 STR_fill ( 0x46 )
Seq
Cmd-code / Par-data
Descriptions
1
0x46
Write string to VP_STR
2
Addr3(MSB)
he VP_STR Address = 0x00000 ~ 0x01FFFF
3
Addr2
(each VP_STR = 128 bytes)
4
Addr1
(address value must be divisible by 128)
5
Addr0(LSB)
6
Lengthh
the number of VP_STR (including the start address) to be filled
7
Lengthl
Length = 1 ~ 1024
8
data
String to write
:
:
Total no. of byte in string ≤ 128
:
:
:
‘ \0 ’
‘ \0 ’(0x00): string end mark
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.4.12 N16_write ( 0x3D )
Seq
Cmd-code / Par-data
Descriptions
1
0x3D
Write 16bit number to VP_N16
2
Addr3(MSB)
VP_N16 Address = 0x080000 ~ 0x08FFFF
3
Addr2
(each VP_N16 = 2 byte)
4
Addr1
(address value must be divisible by 2)
5
Addr0(LSB)
6
High Byte
The 16 bit value to write
7
Low Byte
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.4.13 N16_read ( 0x3E )
Seq
Cmd-code / Par-data
Descriptions
1
0x3E
Read 16bit number from VP_N16
2
Addr3(MSB)
VP_N16 Address = 0x080000 ~ 0x08FFFF
3
Addr2
(each VP_N16 = 2 byte)
4
Addr1
(address value must be divisible by 2)
5
Addr0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x3E
Command executed
3 rd
N16 value
Data1(MSB)
16 bit value
4 th
Data0(LSB)
5 th
Tail
0xCC
Communication packet tail
6 th
0x33
7 th
0xC3
8 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
4.4.14 N16_fill ( 0x3F )
Seq
Cmd-code / Par-data
Descriptions
1
0x3F
Fill 16bit number to the VP_N16
2
Addr3(MSB)
VP_N16 Address = 0x080000 ~ 0x08FFFF
3
Addr2
(each VP_N16 = 2 byte)
4
Addr1
(address value must be divisible by 2)
5
Addr0(LSB)
6
Lengthh
the number of VP_N16 (including the start address) to be filled
7
Lengthl
Length = 1 ~ 32768
8
High Byte
the 16 bit value to fill
9
Low Byte
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 17 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.4.15 N32_write ( 0x44 )
Seq
Cmd-code / Par-data
Descriptions
1
0x44
Write 32bit number to VP_N32
2
Addr3(MSB)
VP_N32 Address = 0x020000 ~ 0x02FFFF
3
Addr2
(each VP_N32 = 4 byte)
4
Addr1
(address value must be divisible by 4)
5
Addr0(LSB)
6
Data3(MSB)
the 32 bit no. value write.
7
Data2
8
Data1
9
Data0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.4.16 N32_read ( 0x45 )
Seq
Cmd-code / Par-data
Descriptions
1
0x45
Read 32bit number from VP_N32
2
Addr3(MSB)
VP_N32 Address = 0x020000 ~ 0x02FFFF
3
Addr2
(each VP_N32 = 4 byte)
4
Addr1
(address value must be divisible by 4)
5
Addr0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x45
Command executed
3 rd
N32 value
Data3(MSB)
32 bit value
4 th
Data2
5 th
Data1
6 th
Data0(LSB)
7 th
Tail
0xCC
Communication packet tail
8 th
0x33
9 th
0xC3
10 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
4.4.17 N32_fill ( 0x47 )
Seq
Cmd-code / Par-data
Descriptions
1
0x47
Fill 32bit number to the VP_N32
2
Addr3(MSB)
VP_N32 Address = 0x020000 ~ 0x02FFFF
3
Addr2
(each VP_N32 = 4 byte)
4
Addr1
(address value must be divisible by 4)
5
Addr0(LSB)
6
Lengthh
the number of VP_N32 (including the start address) to be filled
7
Lengthl
Length = 1 ~ 16384
8
Data3(MSB)
the 32 bit no. value to fill
9
Data2
10
Data1
11
Data0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 18 of 19
TOPWAY
SMART LCD Command Manual
Protocol V5.04
4.4.18 N64_write ( 0x48 )
Seq
Cmd-code / Par-data
Descriptions
1
0x48
Write 64bit number to VP_N64
2
Addr3(MSB)
VP_N64 Address= 0x030000 ~ 0x03FFFF
3
Addr2
(each VP_N64 = 8 byte)
4
Addr1
(address value must be divisible by 8)
5
Addr0(LSB)
6
Data7(MSB)
the 64bit no. value write.
7
Data6
:
:
:
:
12
Data1
13
Data0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
4.4.19 N64_read ( 0x49 )
Seq
Cmd-code / Par-data
Descriptions
1
0x49
Read 64bit number from VP_N64
2
Addr3(MSB)
VP_N64 Address= 0x030000 ~ 0x03FFFF
3
Addr2
(each VP_N64 = 8 byte)
4
Addr1
(address value must be divisible by 8)
5
Addr0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details
Response code:
Seq.
Content
Byte in Hex
Descriptions
1 st
Header
0xAA
Communication packet header
2 nd
Command
0x49
Command executed
3 rd
N64 value
Data7(MSB)
64 bit value
4 th
Data6
:
:
:
:
9 th
Data1
10 th
Data0(LSB)
11 th
Tail
0xCC
Communication packet tail
12 th
0x33
13 th
0xC3
14 th
0x3C
Note.
*1. The Response code with communication packet format (see Communication Packet Structure Section for details)
4.4.20 N64_fill ( 0x4A )
Seq
Cmd-code / Par-data
Descriptions
1
0x4A
Fill 64bit number to the VP_N64
2
Addr3(MSB)
VP_N64 Address= 0x030000 ~ 0x03FFFF
3
Addr2
(each VP_N64 = 8 byte)
4
Addr1
(address value must be divisible by 8)
5
Addr0(LSB)
6
Lengthh
the number of VP_N64 (including the start address) to be filled
7
Lengthl
Length = 1 ~ 8192
8
Data7(MSB)
the 64 bit no. value to fill
9
Data6
:
:
:
:
14
Data1
15
Data0(LSB)
Note.
*1. Command should be transferred in communication packet structure (see Communication Packet Structure Section for details)
URL:
www.topwaydisplay.com
Document Name:SMART LCD Command v5.04 Manual Rev0.4.doc
Page: 19 of 19