Skip to content

Commit

Permalink
cleaning up additional readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
Doczillar authored and sangsoolee committed Jul 28, 2023
1 parent 9167631 commit 4d620e8
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 37 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,14 @@ cd ioter
> Alternatively, you can use a [**Docker image**](docs/guides/DOCKER.md).
## Onboard Matter supported devices
<!-- ![guide1](https://github.com/Samsung/ioter/blob/main/res/doc/guide1.png) -->
> Before using ioter, ensure your SmartThings Stations has been onboarded in the SmartThings app.

After initiating ioter with the run script, the main window will appear with a list of devices.
> Before using ioter, ensure your SmartThings Station has been onboarded in the SmartThings app.
1. Press the start button in the ioter window. The device control window will appear.
After initiating ioter with the run script, the main window will appear and allow you to select a device type.

1. After selecting a device type in the ioter window, press the start button. The device control window will appear.
2. In the device control window that appears, click the power on button. This is the same as the power operation of an actual device. A QR code will be generated that can be used to onboard the device.
3. In the SmartThings app, click the add device button.

<!-- ![guide2](https://github.com/Samsung/ioter/blob/main/res/doc/guide2.png) -->

4. Using the scan QR code option in the SmartThings app, scan the QR code shown in ioter. You may also pair using other options, including using a pairing code or scanning for nearby devices.

After onboarding your virtual device, your device is now controllable from within the SmartThings app.
Expand Down
39 changes: 22 additions & 17 deletions docs/guides/DOCKER.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,38 @@
# Docker image support
You can use a Docker image that 'ioter' environment is prepared.

It confirmed that is working on below host OS:
A Docker image with the ioter environment pre-prepared is available for use.

The following host operating systems are supported:
- Ubuntu Lunar 23.04
- Ubuntu Jammy 22.04 (LTS)
- Ubuntu Focal 20.04 (LTS)
- Ubuntu Bionic 18.04 (LTS)

It also confirmed that there are unsupported host OS:
The following host operating systems are *unsupported*, but may work:
- Ubuntu Xenial 16.04
- macOS
- Any OS running on ARM platform such as Raspberry Pi

## How to start
There are things to be needed to prepare on host side.
1. Set xhost to connect to X server and use X11
> $ xhost +local:root
## Configure the host

Begin by preparing the host side.

2. (For Ubuntu 23.04 only) Stop wireplumber service process that keep Bluetooth service running
> $ systemctl --user stop wireplumber
1. Set xhost to connect to X server and use X11:
`$ xhost +local:root`

3. Turn off Bluetooth service
> $ systemctl stop bluetooth
2. (For Ubuntu 23.04 only) Stop the wireplumber service process that keeps the Bluetooth service running:
`$ systemctl --user stop wireplumber`

3. Turn off the Bluetooth service:
`$ systemctl stop bluetooth`

or

> $ service bluetooth stop
`$ service bluetooth stop`

## Run the Docker container

## Run docker container
You can run with below command.
Run with the command below:
```
sudo docker run --rm -it -e DISPLAY=$DISPLAY \
-v [HOST_IOTER_PATH]:/home/iot/ioter \
Expand All @@ -42,6 +46,7 @@ sudo docker run --rm -it -e DISPLAY=$DISPLAY \
docker.io/spdkimo/ioter:[VERSION] \
python3 ioter/src/main.py
```
- HOST_IOTER_PATH: Path of ioter repository on host pc
- DEVICE_NODE_PATH: Path of device node. For example, most devices starts with 'dev/ttyACM'
- VERSION: ioter image version such as '0.1.0'. You can find details from https://hub.docker.com/r/spdkimo/ioter/tags
Where:
- `HOST_IOTER_PATH`: Path of the ioter repository on the host pc.
- `DEVICE_NODE_PATH`: Path of the device node. For example, most devices start with 'dev/ttyACM'.
- `VERSION`: The ioter image version, such as '0.1.0'. Find details at https://hub.docker.com/r/spdkimo/ioter/tags
24 changes: 11 additions & 13 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
# nRF 52840 DONGLE SETUP GUIDE

## Purpose
In Ioter, OpenThread RCP is used to connect to Thread network. Therefore, it needs to insert Thread RCP firmware into the nrf52840 dongle that will be used.
In ioter, OpenThread RCP is used to connect to the Thread network. Therefore, Thread RCP firmware must be loaded into the nRF52840 dongle that will be used. This guide will help you load the appropriate firmware onto your dongle.

## Guide to create nRF 52840 OpenThread RCP dongle
If you don't know how to insert the firmware into the dongle, this guide is helpful.
1. install 'nRF Connect for Desktop' in Window PC from [Nordic Semiconductor site](https://www.nordicsemi.com/Products/Development-tools/nRF-Connect-for-Desktop/Download?lang=en#infotabs)
2. execute 'nRF Connect for Desktop'
3. install and open 'Programmer'
## Create your nRF 52840 OpenThread RCP dongle
1. Install 'nRF Connect for Desktop' onto a Windows PC from the [Nordic Semiconductor site](https://www.nordicsemi.com/Products/Development-tools/nRF-Connect-for-Desktop/Download?lang=en#infotabs).
2. Launch 'nRF Connect for Desktop'.
3. Install and open 'Programmer' from within 'nRF Connect for Desktop'.
![nrf_connect_for_desktop](https://github.com/Samsung/ioter/assets/110587319/fcc7e468-d4e2-4934-8b6d-4f1afddf8b6b)
5. in 'SELECT DEVICE', select the inserted nrf52840 dongle
![download_mode](https://github.com/Samsung/ioter/assets/110587319/37977049-9d7f-4ea9-8528-30441ad2d03b)
> **Enter donwload mode: please press the button in red-box of upper dongle image before select device after insert a dongle*
5. in 'Add file', select RCP firmware file [ot-rcp-18b6f94.hex (RCP version 6)](ot-rcp-18b6f94.hex)
6. after then, select 'Write'
4. After inserting the dongle, put the nRF52840 dongle into download mode by pressing the button indicated by the red box in the image below.
![download_mode](https://github.com/Samsung/ioter/assets/110587319/37977049-9d7f-4ea9-8528-30441ad2d03b)
5. Click 'SELECT DEVICE' and select the inserted nRF52840 dongle.
6. Click 'Add file' and select the RCP firmware file [ot-rcp-18b6f94.hex (RCP version 6)](ot-rcp-18b6f94.hex).
7. Select 'Write'.
![programmer](https://github.com/Samsung/ioter/assets/110587319/267079af-3ed9-4d26-8256-38c7b58ee55c)

7. OpenThread RCP dongle creation complete!
Your OpenThread RCP dongle creation is now complete!

0 comments on commit 4d620e8

Please sign in to comment.