ykush3_help.txt 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. --------------------------------------------------------------------------
  2. YKUSH 3 Command Appplication Help
  3. --------------------------------------------------------------------------
  4. Legend:
  5. <> Variable
  6. [] Optional parameter
  7. > Command line
  8. 1. Downstream port commands
  9. ---------------------------
  10. The structure of the downstream port commands is as follows.
  11. ykushcmd ykush3 [-s <serial_number>] -<action> <port>
  12. Where:
  13. serial_number Serial number of a board. This is an optional parameter
  14. useful for when multiple boards are attached to the
  15. same host.
  16. action u -> Turn ON/UP the downstream.
  17. d -> Turn OFF/DOWN the downstream.
  18. g -> Get downstream port status.
  19. l -> List boards attached.
  20. port 1, 2 or 3.
  21. Some examples:
  22. Turn OFF the downstream port 1 (if only one YKUSH3 board is attached).
  23. > ykushcmd ykush3 -d 1
  24. Turn OFF the downstream port 1 of the board with serial number YKB00001.
  25. > ykushcmd ykush3 -s YKB00001 -d 1
  26. Get status of downstream port 2
  27. > ykushcmd ykush3 -g 2
  28. List attached YKUSH3 boards
  29. > ykushcmd ykush3 -l
  30. 2. 5V output switched port control commands
  31. -------------------------------------------
  32. The structure of commands.
  33. ykushcmd ykush3 [-s <serial_number>] -<action>
  34. Where:
  35. serial_number Serial number of a board. This is an optional parameter
  36. useful for when multiple boards are attached to the
  37. same host.
  38. action on -> Turn ON.
  39. off -> Turn OFF.
  40. Some examples:
  41. Turn OFF the 5V Out port (if only one YKUSH3 board is attached).
  42. > ykushcmd ykush3 -off
  43. Turn ON the 5V Out port of the board with serial number YKB00001.
  44. > ykushcmd ykush3 -s YKB00001 -on
  45. 3. IO control commands
  46. ----------------------
  47. Structure of commands.
  48. ykushcmd ykush3 [-s <serial_numer>] -<action> <port> [<value>]
  49. Where:
  50. serial_number Serial number of a board. This is an optional parameter
  51. useful for when multiple boards are attached to the
  52. same host.
  53. action w -> Write.
  54. r -> Turn OFF. When Read action the command will return
  55. the read value (1/0). Also in this option, the
  56. <value> parameter is not required.
  57. port 1, 2 or 3.
  58. value 1 -> Set the I/O to digital High Level
  59. 0 -> Set the I/O to digital Low Level
  60. Some examples:
  61. Set GPIO 2 to high (1).
  62. > ykushcmd ykush3 -w 2 1
  63. Read the GPIO 2.
  64. > ykushcmd ykush3 -r 2
  65. NOTE: For Windows operating systems add the .exe extension when calling the ykushcmd command.