Skip to content

Commit

Permalink
readme & wiki update
Browse files Browse the repository at this point in the history 
cmdset bug fix
  • Loading branch information
@renakim
renakim committed May 3, 2018
1 parent ed35791 commit ce13c4a
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 93 deletions.
113 changes: 24 additions & 89 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [SUPPORT DEVICES](#support-devices)
- [CONFIGURATION TOOL](#configuration-tool)
- [CLI Configuration Tool](#cli-configuration-tool)
- [GUI Configuration Tool](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI)
- [GUI Configuration Tool (Go to GUI configuration tool Github page)](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI)
- [TEST TOOL](#test-tool)
- [Loopback Test](#loopback-test)
- [TroubleShooting](#troubleshooting)
Expand Down Expand Up @@ -39,10 +39,13 @@ You can see it on the following links. This content will continue to be updated.
- [WIZ752SR-120](https://wizwiki.net/wiki/doku.php?id=products:s2e_module:wiz752sr-120:start)
- [WIZ752SR-125](https://wizwiki.net/wiki/doku.php?id=products:s2e_module:wiz752sr-125:start)

----

# CONFIGURATION TOOL
- [CLI Configuration Tool](#cli-configuration-tool)
- [GUI Configuration Tool](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI)


## CLI Configuration Tool

### Pre-Check
Expand All @@ -63,88 +66,7 @@ or

### Options

#### Optional arguments:
-h, --help show this help message and exit
-d MACADDR, --device MACADDR
Device mac address to configuration
-a, --all Configuration about all devices (in mac_list.txt)
-c, --clear Mac list clear

#### Configuration:
-s, --search Search devices (in same network)
-r, --reset Reboot device
-f, --factory Factory reset
-m ipaddr, --multiset ipaddr
Set IP address for all devices in 'mac_list.txt'. Parameter is first address.
-u FWFILE, --upload FWFILE
Firmware upload from file
#### General Options:
--alloc {0,1} IP address allocation method (0: Static, 1: DHCP)
--ip IP Local ip address
--subnet SUBNET Subnet mask
--gw GW Gateway address
--dns DNS DNS server address

#### Channel #1 Options:
--port0 PORT0 Local port number
--nmode0 {0,1,2,3} Network operation mode (0: tcpclient, 1: tcpserver, 2: mixed, 3: udp)
--rip0 IP Remote host IP address / Domain
--rport0 PORT Remote host port number
--baud0 BAUD0 baud rate (300|600|1200|1800|2400|4800|9600|14400|19200|28800|38400|57600|115200|230400)
--data0 {0,1} data bit (0: 7-bit, 1: 8-bit)
--parity0 {0,1,2} parity bit (0: NONE, 1: ODD, 2: EVEN)
--stop0 {0,1} stop bit (0: 1-bit, 1: 2-bit)
--flow0 {0,1,2} flow control (0: NONE, 1: XON/XOFF, 2: RTS/CTS)
--time0 TIME0 Time delimiter (0: Not use / 1~65535: Data packing time (Unit: millisecond))
--size0 SIZE0 Data size delimiter (0: Not use / 1~255: Data packing size (Unit: byte))
--char0 CHAR0 Designated character delimiter (00: Not use / Other: Designated character)
--it timer Inactivity timer value for TCP connection close
when there is no data exchange (0: Not use / 1~65535: timer value)
--ka {0,1} Keep-alive packet transmit enable for checking TCP connection established
--ki number Initial TCP keep-alive packet transmission interval value
(0: Not use / 1~65535: Initial Keep-alive packet transmission interval (Unit: millisecond))
--ke number TCP Keep-alive packet transmission retry interval value
(0: Not use / 1~65535: Keep-alive packet transmission retry interval (Unit: millisecond))
--ri number TCP client reconnection interval value [TCP client only]
(0: Not use / 1~65535: TCP client reconnection interval (Unit: millisecond))

#### Channel #2 Options:
--port1 PORT1 Local port number
--nmode1 {0,1,2,3} Network operation mode (0: tcpclient, 1: tcpserver, 2: mixed, 3: udp)
--rip1 IP Remote host IP address / Domain
--rport1 PORT Remote host port number
--baud1 BAUD1 baud rate (300|600|1200|1800|2400|4800|9600|14400|19200|28800|38400|57600|115200|230400)
--data1 {0,1} data bit (0: 7-bit, 1: 8-bit)
--parity1 {0,1,2} parity bit (0: NONE, 1: ODD, 2: EVEN)
--stop1 {0,1} stop bit (0: 1-bit, 1: 2-bit)
--flow1 {0,1,2} flow control (0: NONE, 1: XON/XOFF, 2: RTS/CTS)
--time1 TIME1 Time delimiter (0: Not use / 1~65535: Data packing time (Unit: millisecond))
--size1 SIZE1 Data size delimiter (0: Not use / 1~255: Data packing size (Unit: byte))
--char1 CHAR1 Designated character delimiter (00: Not use / Other: Designated character)
--rv timer Inactivity timer value for TCP connection close
when there is no data exchange (0: Not use / 1~65535: timer value)
--ra {0,1} Keep-alive packet transmit enable for checking TCP connection established
--rs number Initial TCP keep-alive packet transmission interval value
(0: Not use / 1~65535: Initial Keep-alive packet transmission interval (Unit: millisecond))
--re number TCP Keep-alive packet transmission retry interval value
(0: Not use / 1~65535: Keep-alive packet transmission retry interval (Unit: millisecond))
--rr number TCP client reconnection interval value [TCP client only]
(0: Not use / 1~65535: TCP client reconnection interval (Unit: millisecond))

#### UART Command mode switch settings:
--te {0,1} Serial command mode switch code enable
--ss 3-byte hex Serial command mode switch code (default: 2B2B2B)

#### ETC options:
--cp {0,1} TCP connection password enable [TCP server mode only]
--np pw TCP connection password (string, up to 8 bytes / default: None) [TCP server mode only]
--sp value Search identification code (string, up to 8 bytes / default: None)
--dg {0,1} Serial debug message enable (Debug UART port)

#### Configuration from File:
--setfile SETFILE File name to Set
--getfile GETFILE File name to Get info. Refer default command(cmd_oneport.txt or cmd_twoport.txt).
You can check the all available options from this Wiki page: [Getting Started Guide - Options.](https://github.com/Wiznet/WIZnet-S2E-Tool/wiki/Options)

----

Expand Down Expand Up @@ -173,7 +95,7 @@ First, you could search devices use '-s' or '--search' option.
$ python wizconfig.py -s
And then **mac_list.txt** is created, there are MAC address information of each device.

</br>
----

#### 2. Configuration
First, find the option(s) for you want to set from [Options](#options). And then config the device(s) use following command.
Expand All @@ -198,7 +120,7 @@ First, find the option(s) for you want to set from [Options](#options). And then

$ python wizconfig.py -a --baud0 115200

</br>
----

#### 3. Firmware Upload

Expand All @@ -210,7 +132,7 @@ So first, use **-m/--multiset** option for **set ip address to the same network-
$ python wizconfig.py -m <IP address>

##### Step 2 - Firmware upload
Next, prepare the fireware file. You must use **App Boot firmware** file when do this.
Next, prepare the firmware file. You must use **App Boot firmware** file when do this.

To download firmware file, refer below link.
- https://github.com/Wiznet/WIZ750SR/releases
Expand Down Expand Up @@ -245,7 +167,7 @@ If your host PC use IP '192.168.0.X',

$ python wizconfig.py -a -u W7500x_S2E_App.bin

</br>
----

#### 4. Get/Set configs Use File

Expand Down Expand Up @@ -289,7 +211,7 @@ GW192.168.0.1
LP5000
BR12</pre></code>

Then, config deivce use --setfile option.
Then, config device use --setfile option.

* Single device

Expand Down Expand Up @@ -339,5 +261,18 @@ This tool is perform simple loopback test for functional verification of WIZ75XS

$ python wiz75x_loopback_test.py -s 2 -t 192.168.0.100

----

# Wiki

You can check the contents of configuration tool wiki on the [WIZnet-S2E-Tool wiki page.](https://github.com/Wiznet/WIZnet-S2E-Tool/wiki)

----


# TroubleShooting
If you have any problems, please visit [WIZnet Forum](https://forum.wiznet.io/) and please let we know what the problem is.

If you have any problems, use one of the links below and **please report the problem.**

- [Github Issue page](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/issues)
- [WIZnet Forum](https://forum.wiznet.io/)
4 changes: 2 additions & 2 deletions WIZ750CMDSET.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ def __init__(self, log_level):
"^([0-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9][0-9][0-9]|65[0-4][0-9][0-9]|655[0-2][0-9]|6553[0-5])$",
{}, "RW"],
"BR" : ["UART Baud rate",
"^([0-9]|1[0-3])$",
"^([0-9]|1[0-4])$",
{"0" : "300", "1" : "600", "2" : "1200", "3" : "1800", "4" : "2400", "5" : "4800", "6" : "9600", "7" : "14400",
"8" : "19200", "9" : "28800", "10" : "38400", "11" : "57600", "12" : "115200", "13" : "230400"},
"8" : "19200", "9" : "28800", "10" : "38400", "11" : "57600", "12" : "115200", "13" : "230400", "14" : "460800"},
"RW"],
"DB" : ["UART Data bit length", "^[0-1]$", {"0" : "7-bit", "1" : "8-bit"}, "RW"],
"PR" : ["UART Parity bit", "^[0-2]$", {"0" : "NONE", "1" : "ODD", "2" : "EVEN"}, "RW"],
Expand Down
4 changes: 2 additions & 2 deletions WIZ752CMDSET.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ def __init__(self, log_level):
"^([0-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9][0-9][0-9]|65[0-4][0-9][0-9]|655[0-2][0-9]|6553[0-5])$",
{}, "RW"],
"BR" : ["UART channel 0 Baud rate",
"^([0-9]|1[0-3])$",
"^([0-9]|1[0-4])$",
{"0" : "300", "1" : "600", "2" : "1200", "3" : "1800", "4" : "2400", "5" : "4800", "6" : "9600", "7" : "14400",
"8" : "19200", "9" : "28800", "10" : "38400", "11" : "57600", "12" : "115200", "13" : "230400"},
"8" : "19200", "9" : "28800", "10" : "38400", "11" : "57600", "12" : "115200", "13" : "230400", "14" : "460800"},
"RW"],
"EB" : ["UART channel 1 Baud rate",
"^([0-9]|1[0-3])$",
Expand Down

0 comments on commit ce13c4a

Please sign in to comment.