Skip to content

Commit b1925ba

Browse files
constmonicaconstmonica
authored
Merge pull request #1 from constmonica/docs-swiot-update
Docs swiot update
2 parents cb27032 + 2aaa5c7 commit b1925ba

3 files changed

Lines changed: 29 additions & 28 deletions

File tree

‎docs/solutions/reference-designs/ad-swiot1l-sl/firmware-guide/index.rst‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ System Setup
1212
------------
1313

1414
- Connect the AD-SWIOT1L-SL to the AD-T1LUSB2.0-EBZ using the single pair Ethernet cable.
15-
- Connect the AD-T1LUSB2.0-EBZ to your PC using an USB cable.
15+
- Connect the AD-T1LUSB2.0-EBZ to your PC using an usb cable.
1616
- Connect the 24 V power supply to the AD-SWIOT1L-SL.
1717

1818
.. figure:: picture1.jpg
@@ -40,24 +40,24 @@ the way to production firmware and applications development.
4040
.. important::
4141

4242
The system comes pre-programmed with a standard firmware. To work with
43-
**Scopy**, you need to flash the specific static IP firmware version.
43+
**Scopy**, you need to flash the specific static ip firmware version.
4444

4545
**Scopy** will work only with the official
4646
`AD-SWIOT1L-SL firmware releases <https://github.com/analogdevicesinc/no-OS/releases/tag/swiot1l-v1.1.0>`_
4747

4848
Updating the AD-SWIOT1L-SL Firmware
4949
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5050

51-
To update the firmware on the AD-SWIOT1L-SL, the MAX32625PICO programmer is used as a SWD interface to flash the new firmware image. The MAX32625PICO comes with a default bootloader that we need to replace.
51+
To update the firmware on the AD-SWIOT1L-SL, the MAX32625PICO programmer is used as a swd interface to flash the new firmware image. The MAX32625PICO comes with a default bootloader that we need to replace.
5252

5353

5454
#. Download the firmware image: `MAX32625PICO firmware <https://github.com/MaximIntegrated/max32625pico-firmware-images/raw/master/bin/max32625_max32650fthr_if_crc_swd_v1.0.6.bin>`__
5555
#. Set the MAX32625PICO in MAINTENANCE mode:
5656

5757
* Disconnect the MAX32625PICO from the PC and the AD-SWIOT1L-SL board.
58-
* Plug the micro USB cable only in the MAX32625PICO.
58+
* Plug the micro usb cable only in the MAX32625PICO.
5959
* Keep the button on the MAX32625PICO pressed.
60-
* Plug the micro USB cable into the PC.
60+
* Plug the micro usb cable into the PC.
6161
* Once you see the MAINTENANCE drive being mounted, you may release the button.
6262

6363
.. figure:: MAINTENANCE.jpg
@@ -72,23 +72,24 @@ To update the firmware on the AD-SWIOT1L-SL, the MAX32625PICO programmer is used
7272
:align: center
7373

7474
#. After a few seconds, the MAINTENANCE drive will disappear and will be replaced
75-
by a drive named DAPLINK. Once this is done, the process is complete, and the
76-
MAX32625PICO may be used to flash the firmware of the AD-SWIOT1L-SL board.
75+
by a drive named Daplink. Once this is done, the process is complete, and the
76+
MAX32625PICO may be used to flash the firmware on the AD-SWIOT1L-SL board.
7777

7878
Programming the AD-SWIOT1L-SL
7979
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8080

81-
- Connect the MAX32625PICO to the PC using the micro USB cable.
81+
- Connect the MAX32625PICO to the PC using the micro usb cable.
8282
- Connect the MAX32625PICO to the AD-SWIOT1L-SL board using the 10-pin ribbon cable.
8383
- Connect the 24 V power supply to the AD-SWIOT1L-SL. Make sure the board is powered up for the next steps.
8484

8585
.. figure:: img_20230912_145550.jpg
8686

8787
AD-SWIOT1L-SL Programming Setup
8888

89-
* A DAPLINK drive should appear as mounted on your PC.
90-
* Drag and drop the new firmware image into the DAPLINK drive. After a few seconds, the drive will be remounted.
91-
* Check the DAPLINK directory and make sure there is no FAIL.TXT file. In case
89+
* A Daplink should appear as mounted on your PC.
90+
* Drag and drop the new firmware image into the Daplink drive. After a few
91+
seconds, the drive will be remounted.
92+
* Check the Daplink directory and make sure there is no FAIL.TXT file. In case
9293
there is, repeat the drag and drop step. Otherwise, you may disconnect the
9394
MAX32625PICO from the AD-SWIOT1L-SL, since the firmware update is complete.
9495

@@ -100,5 +101,5 @@ The :git-no-OS:`AD-SWIOT1L-SL firmware <projects/swiot1l>` is
100101
based on Analog Devices’ open-source no-OS framework, which includes all the
101102
tools required for embedded code development and debugging as well as libraries
102103
enabling host-side connectivity for system configuration and data transfer over
103-
the UART or the 10BASE-T1L interfaces. The firmware source code and related
104+
the uart the 10BASE-T1L interfaces. The firmware source code and related
104105
documentation can be found on the Analog Devices GitHub at the link above.

‎docs/solutions/reference-designs/ad-swiot1l-sl/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ system together and get it up and running in no time.
4949
This is what you’ll find in the development kit box:
5050

5151
- 1 x :adi:`AD-SWIOT1L-SL` board with enclosure
52-
- 1 x :adi:`AD-T1LUSB-EBZ` 10BASE-T1L to USB adapter board
53-
- 1 x PROFIBUS (1x2x18AWG) cable for Single Pair Ethernet (SPE) connectivity
54-
- 1 x USB 2.0 cable
52+
- 1 x :adi:`AD-T1LUSB-EBZ` 10BASE-T1L to usb adapter board.
53+
- 1 x Profibus (1x2x18AWG) cable for Single Pair Ethernet (SPE) connectivity
54+
- 1 x usb 2.0 cable
5555
- 1 x cable connector for the external 24 V power supply
5656
- 1 x cable connector for channels connectivity
5757

‎docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ System Setup
1212
------------
1313

1414
- Connect the AD-SWIOT1L-SL to the AD-T1LUSB2.0-EBZ using the single pair Ethernet cable.
15-
- Connect the AD-T1LUSB2.0-EBZ to your PC using an USB cable.
15+
- Connect the AD-T1LUSB2.0-EBZ to your PC using an usb cable
1616
- Connect the 24 V power supply to the AD-SWIOT1L-SL.
1717

1818
Windows User Guide
1919
------------------
2020
- Connect the AD-SWIOT1L-SL to your Windows PC using the AD-T1LUSB2.0-EBZ.
2121

2222
To communicate with the AD-SWIOT1L-SL board, you need to configure your Windows
23-
PC's network adapter with a static IP address in the same subnet as the board e.g 192.168.97.1/24
23+
PC's network adapter with a static ip address in the same subnet as the board e.g 192.168.97.1/24
2424

25-
The AD-SWIOT1L-SL board uses the static IP address: **192.168.97.40**
25+
The AD-SWIOT1L-SL board uses the static ip address: **192.168.97.40**
2626

2727
Configure Windows Network Adapter
2828
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -32,15 +32,15 @@ Configure Windows Network Adapter
3232
:width: 400 px
3333
:align: center
3434

35-
2. Select your ethernet interface and click "Edit" to modify the IP settings
35+
2. Select your Ethernet interface and click "Edit" to modify the ip settings
3636

3737
.. figure:: 2.png
3838
:width: 300 px
3939
:align: center
4040

41-
3. Set the IP settings to manual and configure the following values:
41+
3. Set the ip settings to manual and configure the following values:
4242

43-
- **IP address**: 192.168.97.1
43+
- **ip address**: 192.168.97.1
4444
- **Subnet mask**: 255.255.255.0
4545

4646
.. figure:: 3.png
@@ -53,7 +53,7 @@ Configure Windows Network Adapter
5353
:width: 450 px
5454
:align: center
5555

56-
4. Open a command prompt and verify the new assigned IP address using the command:
56+
4. Open a command prompt and verify the new assigned ip address using the command:
5757

5858
.. code:: bash
5959
@@ -75,16 +75,16 @@ Configure Windows Network Adapter
7575

7676
.. Add Windows-specific instructions here
7777
78-
Linux User Guide
78+
linux User Guide
7979
----------------
80-
- Connect the AD-SWIOT1L-SL to your Linux PC using the AD-T1LUSB2.0-EBZ
80+
- Connect the AD-SWIOT1L-SL to your linux PC using the AD-T1LUSB2.0-EBZ
8181

8282

83-
To communicate with the AD-SWIOT1L-SL board, you need to configure your Linux PC’s network
83+
To communicate with the AD-SWIOT1L-SL board, you need to configure your linux PC's network
8484
adapter with a static IP address in the same subnet as the board e.g 192.168.97.1/24.
8585

8686

87-
Configure Linux Network Adapter
87+
Configure linux Network Adapter
8888
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8989

9090
1. Identify the network interface corresponding to the AD-T1LUSB2.0-EBZ using the command:
@@ -93,7 +93,7 @@ Configure Linux Network Adapter
9393
:width: 300 px
9494
:align: center
9595

96-
2. Configure the network interface with a static IP address:
96+
2. Configure the network interface with a static ip address:
9797

9898
.. figure:: linux_2.png
9999
:width: 400 px
@@ -127,7 +127,7 @@ comprehensive `Scopy Plugin Documentation <https://analogdevicesinc.github.io/sc
127127
Using the IIO interface
128128
------------------------------
129129

130-
The firmware is based on a no-OS implementation of the IIO framework from the Linux kernel, which offers similar functionalities.
130+
The firmware is based on a no-OS implementation of the IIO framework from the linux kernel, which offers similar functionalities.
131131
Thus, the board may be configured through the use of pyadi-iio API.
132132

133133
In order to get the pyadi-iio drivers follow the next steps:

0 commit comments

Comments
 (0)