Skip to content

Commit 2ce3fdb

Browse files
committed
doc: add iotdk getting_started doc,minor fix for other doc
Signed-off-by: Yuguo Zou <[email protected]>
1 parent 3ba52eb commit 2ce3fdb

File tree

4 files changed

+61
-3
lines changed

4 files changed

+61
-3
lines changed

doc/documents/getting_started/getting_started.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ Use the following procedures to prepare your ARC board to run/debug the embARC a
8484

8585
getting_started_with_em_starter_kit.rst
8686
getting_started_with_hs_development_kit.rst
87+
getting_started_with_iot_development_kit.rst
8788

8889
See the following procedures to check peripherals and board settings. The peripherals are not required for all the embARC OSP examples.
8990

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
.. _getting_started_with_iot_development_kit:
2+
3+
Getting Started with IoT Development Kit
4+
========================================
5+
6+
Supported Hardware
7+
##################
8+
9+
The DesignWare® ARC® IoT Development Kit (IoTDK) is a versatile platform that includes the necessary hardware and software to accelerate software development and debugging of sensor fusion, voice recognition and face detection designs. RTOS & bare metal applications can be developed using the embARC Open Software Platform (OSP). I/O functionality can be extended using Digilent® Peripheral Modules (Pmods™), as well as Arduino Shields and mikrobus modules.
10+
11+
For further information, see :ref:`board_iotdk`
12+
13+
Setting Up IoTDK
14+
################
15+
16+
#. Switch DIP switches to the OFF position (closest to the edge of the board).
17+
18+
#. Connect your PC and IoTDK board with USB cable to micro USB port next to 5V DC power connector on board.
19+
20+
#. (Optional) Connect 5V DC power connector with 5V AC/DC adapter.
21+
22+
#. You can use any terminal emulation program to view UART output from the IoTDK. The USB connection provides both the debug channel and RS232 transport. Use PuTTY application on Windows as an example.
23+
24+
* Determine which COM port the IoTDK is using.
25+
26+
* Open the **Windows Control Panel** and select **Device Manager** in a Windows environment.
27+
* Expand **Ports (COM and LPT)** in the list. Select **USB Serial Port (COM x)** and note the COM port number for the ARC board.
28+
29+
* Configure serial terminal connection.
30+
31+
* Launch PuTTY. Select **Serial** under **Connection type** and enter the appropriate COM port string under **Serial line**.
32+
* Choose 115200 baud, 8 bits, 1 stop bit, no parity (115200-8-N-1) in settings.
33+
* You can optionally save your settings so they can be easily retrieved every time PuTTY is launched.
34+
* Click Open to open the console.
35+
36+
#. Test serial output with IoTDK.
37+
38+
* Press the reset button on the IoTDK board to reset the board and run the uboot.
39+
* Confirm that you can see the message printed to the console as shown below.
40+
41+
.. code-block:: console
42+
43+
U-Boot 2018.03-rc3-00028-g161e5eeaa4a4-dirty (Mar 05 2018 - 12:56:14 +0300)
44+
45+
DRAM: 128 KiB
46+
MMC: Synopsys Mobile storage: 0
47+
Loading Environment from FAT... Card did not respond to voltage select!
48+
** Bad device mmc 0 **
49+
Failed (-5)
50+
In: serial0@80014000
51+
Out: serial0@80014000
52+
Err: serial0@80014000
53+
=>
54+
55+
56+
#. (Optional) Connect peripheral modules to the IoTDK as per :ref:`peripheral_preparation`.
57+

doc/documents/getting_started/peripheral_preparation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Now your code should be like this:
3232
3333
.. note:: Notice that **UR** means Upper Layer of Pmod interface and **LR** means Lower Layer of Pmod
3434

35-
3. If you are using HSDK, go to mux.c and find ``io_mux_init()`` function, you will see it calls ``creg_hsdc_set_gpio_mux()`` with paramater array ``gpio_mux_config`` as MUX options.
35+
3. If you are using HSDK, go to mux.c and find ``io_mux_init()`` function, you will find it calls ``creg_hsdc_set_gpio_mux()`` with paramater array ``gpio_mux_config`` as MUX options.
3636
By default all pins are set to GPIO, other MUX options are defined in ``PINMUX_TYPE`` in ``embarc_osp/device/inc/dev_pinmux.h``
3737

3838
.. note:: To learn what interface your board has, please go to :ref:`board_bsp`
@@ -64,4 +64,4 @@ Driver code at ``embarc_osp/device/peripheral/adc/ad7991``.
6464

6565
`ESP01\/ESP01S <http://wiki.ai-thinker.com/esp8266/docs>`_ : Primary IC type is ESP8266, use **UART** interface for data changing and controlling.
6666
Driver code at ``embarc_osp/device/peripheral/wifi/slip_esp``.
67-
The ESP01/ESP01S module is not originally a PMOD module, however it is PMOD campatible, which means you could wire it to PMOD interface on board. You need to connect GCC(embARC) to GCC(ESP) , 3.3V(embARC) to VCC, RXD(embARC) to TXD(ESP), and TXD(embARC) to RXD(ESP), respectively. Please take reference from datasheet of `ESP01\/ESP01S <http://wiki.ai-thinker.com/esp8266/docs>`_ and UART (type 4A) part of `Digilent Pmod Spec <https://www.digilentinc.com/Pmods/Digilent-Pmod_%20Interface_Specification.pdf>`_ for pin layout.
67+
The ESP01/ESP01S module is not originally a PMOD module, however it is PMOD campatible, meaning that you could wire it to PMOD interface on board. You need to connect GCC(embARC) to GCC(ESP) , 3.3V(embARC) to VCC, RXD(embARC) to TXD(ESP), and TXD(embARC) to RXD(ESP), respectively. Please take reference from datasheet of `ESP01\/ESP01S <http://wiki.ai-thinker.com/esp8266/docs>`_ and UART (type 4A) part of `Digilent Pmod Spec <https://www.digilentinc.com/Pmods/Digilent-Pmod_%20Interface_Specification.pdf>`_ for pin layout.

example/freertos/iot/coap/coap_server/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Detailed Description
3030
Buidling and Running
3131
********************
3232

33-
This example outputs to the console. It is supported by all platform. You might need to change mux configurations or connect wires in order to use peripheral modules, see :ref:`peripheral_preparation`.
33+
This example outputs to the console. It is supported by all platform. You might need to change MUX configurations or connect wires in order to use peripheral modules, see :ref:`peripheral_preparation`.
3434
The commands to run this example are as follows:
3535

3636
.. code-block:: console

0 commit comments

Comments
 (0)