Skip to content

Commit 8aff6c4

Browse files
committed
Add some documentation about new commands
1 parent 9ff6346 commit 8aff6c4

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Reset the device:
152152

153153
$ evic-usb reset
154154

155-
Dump any part of the flash memory:
155+
Dump any part of the flash memory (May not work with all firmwares):
156156

157157
::
158158

@@ -164,13 +164,13 @@ Example to read the parameters flash memory:
164164

165165
$ evic-usb fmc-read -o out.bin -s 122880 -l 4096
166166

167-
Setup date and time of the device to the current time:
167+
Setup date and time of the device to the current time (For firmwares supporting clock display):
168168

169169
::
170170

171171
$ evic-usb time
172172

173-
Take a screenshot of the device display:
173+
Take a screenshot of the device display (May not work with all firmwares):
174174

175175
::
176176

evic/cli.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,10 @@ def reset():
327327

328328
@usb.command('time')
329329
def time():
330-
"""Sets the device date/time to now."""
330+
"""Sets the device date/time to now.
331+
Works only with devices and/or firmwares
332+
supporting a clock-screen on the display.
333+
"""
331334

332335
dev = evic.HIDTransfer()
333336

evic/device.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ def read_dataflash(self):
179179

180180
def fmc_read(self, start, length):
181181
"""Reads the device flash memory.
182+
May not work with all devices or firmwares.
182183
183184
Returns:
184185
An array containing the data flash memory content.
@@ -207,6 +208,7 @@ def hid_command(self, cmd, start, length):
207208

208209
def read_screen(self):
209210
"""Reads the screen memory.
211+
May not work with all devices or firmwares.
210212
211213
Returns:
212214
An array containing the screen.

0 commit comments

Comments
 (0)