Skip to content

Commit

Permalink
Add some documentation about new commands
Browse files Browse the repository at this point in the history
  • Loading branch information
besser82 committed Jan 6, 2018
1 parent 9ff6346 commit 8aff6c4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Reset the device:

$ evic-usb reset

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

::

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

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

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

::

$ evic-usb time

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

::

Expand Down
5 changes: 4 additions & 1 deletion evic/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,10 @@ def reset():

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

dev = evic.HIDTransfer()

Expand Down
2 changes: 2 additions & 0 deletions evic/device.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ def read_dataflash(self):

def fmc_read(self, start, length):
"""Reads the device flash memory.
May not work with all devices or firmwares.
Returns:
An array containing the data flash memory content.
Expand Down Expand Up @@ -207,6 +208,7 @@ def hid_command(self, cmd, start, length):

def read_screen(self):
"""Reads the screen memory.
May not work with all devices or firmwares.
Returns:
An array containing the screen.
Expand Down

0 comments on commit 8aff6c4

Please sign in to comment.