Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

- **Development kit**: :adi:`AD-SWIOT1L-SL` Software-configurable Analog and Digital I/O with 10BASE-T1L
- **Power supplies**: 24V power supply at minimum 2A
- **Programmer**: :adi:`MAX32625PICO` or any other similar programmer supporting the SWD interface

Check failure on line 9 in docs/solutions/reference-designs/ad-swiot1l-sl/firmware-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Terms:86 Use 'swd' instead of 'SWD'.

System Setup
------------

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

.. figure:: picture1.jpg
Expand Down Expand Up @@ -40,24 +40,24 @@
.. important::

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

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

Updating the AD-SWIOT1L-SL Firmware
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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.
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.


#. 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>`__
#. Set the MAX32625PICO in MAINTENANCE mode:

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

.. figure:: MAINTENANCE.jpg
Expand All @@ -72,23 +72,24 @@
:align: center

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

Programming the AD-SWIOT1L-SL
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. figure:: img_20230912_145550.jpg

AD-SWIOT1L-SL Programming Setup

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

Expand All @@ -100,5 +101,5 @@
based on Analog Devices’ open-source no-OS framework, which includes all the
tools required for embedded code development and debugging as well as libraries
enabling host-side connectivity for system configuration and data transfer over
the UART or the 10BASE-T1L interfaces. The firmware source code and related
the uart the 10BASE-T1L interfaces. The firmware source code and related
documentation can be found on the Analog Devices GitHub at the link above.
6 changes: 3 additions & 3 deletions docs/solutions/reference-designs/ad-swiot1l-sl/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ system together and get it up and running in no time.
This is what you’ll find in the development kit box:

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@

- **Development kit**: :adi:`AD-SWIOT1L-SL` Software-configurable Analog and Digital I/O with 10BASE-T1L
- **Power supplies**: 24V power supply at minimum 2A
- **Programmer**: :adi:`MAX32625PICO` or any other similar programmer supporting the SWD interface

Check failure on line 9 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Terms:86 Use 'swd' instead of 'SWD'.

System Setup
------------

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

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

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

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

Configure Windows Network Adapter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -32,15 +32,15 @@
:width: 400 px
:align: center

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

.. figure:: 2.png
:width: 300 px
:align: center

3. Set the IP settings to manual and configure the following values:
3. Set the ip settings to manual and configure the following values:

- **IP address**: 192.168.97.1
- **ip address**: 192.168.97.1
- **Subnet mask**: 255.255.255.0

.. figure:: 3.png
Expand All @@ -53,7 +53,7 @@
:width: 450 px
:align: center

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

.. code:: bash

Expand All @@ -75,16 +75,16 @@

.. Add Windows-specific instructions here

Linux User Guide
linux User Guide
----------------
- Connect the AD-SWIOT1L-SL to your Linux PC using the AD-T1LUSB2.0-EBZ
- Connect the AD-SWIOT1L-SL to your linux PC using the AD-T1LUSB2.0-EBZ


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

Check failure on line 84 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Terms:23 Use 'ip' instead of 'IP'.


Configure Linux Network Adapter
Configure linux Network Adapter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Identify the network interface corresponding to the AD-T1LUSB2.0-EBZ using the command:
Expand All @@ -93,7 +93,7 @@
:width: 300 px
:align: center

2. Configure the network interface with a static IP address:
2. Configure the network interface with a static ip address:

.. figure:: linux_2.png
:width: 400 px
Expand Down Expand Up @@ -124,10 +124,10 @@
comprehensive `Scopy Plugin Documentation <https://analogdevicesinc.github.io/scopy/plugins/swiot1l/index.html>`_.


Using the IIO interface

Check failure on line 127 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Terms:11 Use 'iio' instead of 'IIO'.
------------------------------

The firmware is based on a no-OS implementation of the IIO framework from the Linux kernel, which offers similar functionalities.
The firmware is based on a no-OS implementation of the IIO framework from the linux kernel, which offers similar functionalities.

Check failure on line 130 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Terms:56 Use 'iio' instead of 'IIO'.
Thus, the board may be configured through the use of pyadi-iio API.

In order to get the pyadi-iio drivers follow the next steps:
Expand All @@ -138,7 +138,7 @@

git clone https://github.com/analogdevicesinc/pyadi-iio

#. Follow the installation steps provided in the `pyadi-iio README <https://github.com/analogdevicesinc/pyadi-iio>`_.

Check failure on line 141 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Terms:61 Use 'readme' instead of 'README'.

#. Update your ``PYTHONPATH`` environment variable to include the pyadi-iio's root directory:

Expand All @@ -146,7 +146,7 @@

Open the Environment Variables window and add (or update) the ``PYTHONPATH`` system variable.

**Linux:**

Check failure on line 149 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Terms:6 Use 'linux' instead of 'Linux'.

Option 1 (temporary, current terminal only):

Expand All @@ -171,7 +171,7 @@

### this might need changing once swiot is merged into main

#. Checkout the `swiot branch <https://github.com/analogdevicesinc/pyadi-iio/tree/swiot>`_:

Check failure on line 174 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Spelling:18 Did you really mean 'swiot'?

.. code-block:: bash

Expand All @@ -189,11 +189,11 @@
This section provides a high-level overview of how the firmware manages
device configuration. Detailed field device usage information is presented in
the following sections. When powered, the SWIOT1L board operates in one of
two states, each identified by a distinct IIO context:

Check failure on line 192 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Terms:43 Use 'iio' instead of 'IIO'.

- **Config**: All channels are in a high impedance state. Users can configure
channel functions and route each SWIOT1L channel to either the MAX14906
or AD74413R device using the swiot virtual device.

Check failure on line 196 in docs/solutions/reference-designs/ad-swiot1l-sl/software-guide/index.rst

View workflow job for this annotation

GitHub Actions / check-doc

vale:Vale.Spelling:32 Did you really mean 'swiot'?

.. note::

Expand Down
Loading