Skip to content

Commit a43a0e8

Browse files
committed
doc: rewrite ntshell doc, other minor fix
Signed-off-by: Yuguo Zou <[email protected]>
1 parent 2ce3fdb commit a43a0e8

File tree

2 files changed

+28
-7
lines changed

2 files changed

+28
-7
lines changed

example/freertos/iot/lwm2m/lwm2m_server/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Then, you could try out ``lwm2m_op`` command from server side, and also try to u
5555
Sample Output
5656
=============
5757

58-
Here is sample output from LwM2M server, highlight lines are user imput.
58+
Here is sample output from LwM2M server, highlight lines are user input.
5959

6060
.. code-block:: console
6161
:emphasize-lines: 72,76

example/freertos/net/ntshell/README.rst

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,26 @@ Detailed Description
1818
Digilent PMOD WIFI (MRF24WG0MA)
1919

2020
* Design Concept
21-
The Pmod modules should be connected to EMSK. This example is designed to show how to use NT-Shell over network in FreeRTOS
21+
The Pmod modules should be connected to your embARC board. This example is designed to show how to use NT-Shell over network in FreeRTOS.
2222

2323
* Usage Manual
24-
This is an example running NT-Shell command interface ver network, and use telnet to connect to it
25-
- when program is running and connected to the wifi hotspot, then you can connect your laptop to the same wifi hotspot that emsk connected to
26-
- use telnet command to connect to the ip address of emsk. If there are outputs, then you can run and try out ntshell commands
27-
- some commands require extra peripheral modules, for example command temp require Digilent PMOD TMP2 module in order to mesure temperature
24+
This is an example running NT-Shell command interface over network, and use telnet to connect to it:
25+
- First setup your WiFi AP which your board would connect to. The default SSID is ``embARC``, default password is ``qazwsxedc``.
26+
- Run the example program on your board, wait until it is connected to the wifi. When you see the message showing below, type ``main`` to console to run the main program which is a Telnet server running at port 23 on board's IP address.
27+
28+
.. code-block:: console
29+
30+
Please run NT-Shell command(main) to start your application.
31+
main command may required some arguments, please refer to example's document.
32+
33+
- Make sure your PC is in the same IP section of your board. For example, you can connect your laptop to the same wifi which your board is connected to.
34+
- Open another cmd console / terminal, use telnet command to connect to the ip address of your board. If there are outputs, then you can run and try out ntshell commands. An telnet example is given below, in this example the IP address of the board is ``192.168.137.108``.
35+
36+
.. code-block:: console
37+
38+
$ telnet 192.168.137.108
39+
40+
- Some commands require extra peripheral modules, for example command temp require Digilent PMOD TMP2 module in order to measure temperature
2841

2942
* Extra Comments
3043
NO
@@ -43,7 +56,10 @@ This example outputs to the console. It is supported by all platform. The comman
4356
Sample Output
4457
=============
4558

59+
Here is sample output from ntshell example, highlight lines are user input.
60+
4661
.. code-block:: console
62+
:emphasize-lines: 73
4763
4864
-----------------------------------------------------------
4965
____ _ ____
@@ -116,4 +132,9 @@ Sample Output
116132
WiFi connected
117133
Please run NT-Shell command(main) to start your application.
118134
119-
main command may required some arguments, please refer to example's document.
135+
main command may required some arguments, please refer to example's document.
136+
main
137+
NT-Shell for FreeRTOS + LwIP + FatFs
138+
Now please telnet to the IPAddr @ Port 23, to run ntshell ver telnet
139+
Command line like this: telnet ipaddr port
140+
COM1>

0 commit comments

Comments
 (0)