Skip to content

Commit

Permalink
doc : Changes as discussed
Browse files Browse the repository at this point in the history
Minor documenation changes

Signed-off-by: Akarshan Kapoor <data.akarshan@icloud.com>
  • Loading branch information
Kappuccino111 committed May 28, 2024
1 parent 3451c08 commit 833b7d2
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 29 deletions.
4 changes: 4 additions & 0 deletions doc/source/_static/FlowNexus-Architecture-Final.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 29 additions & 29 deletions doc/source/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Features
* Receive logs from IoT Devices.


.. figure:: _static/FlowNexus-Architecture.jpg
.. figure:: _static/FlowNexus-Architecture-Final.svg

Key Components
--------------
Expand Down Expand Up @@ -162,25 +162,25 @@ Before you we start with any development here are a few things you should get co

.. code-block:: console
host:root_dir$ sudo apt update && sudo apt upgrade
host:root_dir$ sudo apt install python3-pip python3.10-venv
host:root_dir$ python3.10 -m venv venv
host:root_dir$ source venv/bin/activate
host:root_dir$ pip install --upgrade pip && pip install west
host:root_dir$ west init -m https://github.com/jonas-rem/lwm2m_server --mr main flownexus_workspace
host:root_dir$ cd flownexus_workspace
host:root_dir/flownexus_workspace$ west update
host:~$ sudo apt update && sudo apt upgrade
host:~$ sudo apt install python3-pip python3.10-venv
host:~$ python3.10 -m venv venv
host:~$ source venv/bin/activate
host:~$ pip install --upgrade pip && pip install west
host:~$ west init -m https://github.com/jonas-rem/lwm2m_server --mr main flownexus_workspace
host:~$ cd flownexus_workspace
host:~/flownexus_workspace$ west update
Contributing to the Documentation
.................................

.. code-block:: console
host:root_dir$ sudo apt-get install default-jre plantuml graphviz
host:root_dir$ source venv/bin/activate
host:root_dir$ cd flownexus_workspace/lwm2m_server/doc
host:root_dir/flownexus_workspace/lwm2m_server/doc$ pip install -r requirements.txt
host:root_dir/flownexus_workspace/lwm2m_server/doc$ tox -e py3-html
host:~$ sudo apt-get install default-jre plantuml graphviz
host:~$ source venv/bin/activate
host:~$ cd flownexus_workspace/lwm2m_server/doc
host:lwm2m_server/doc$ pip install -r requirements.txt
host:lwm2m_server/doc$ tox -e py3-html
Open the generated index.html in the doc/build directory in your browser.

Expand All @@ -191,10 +191,10 @@ Make sure to create a virtual environment and install the requirements:

.. code-block:: console
host:root_dir$ source venv/bin/activate
host:root_dir$ cd flownexus_workspace/lwm2m_server/server/django
host:root_dir/flownexus_workspace/lwm2m_server/server/django$ pip install -r requirements.txt
host:root_dir/flownexus_workspace/lwm2m_server/server/django$ chmod +x django_start.sh && ./django_start.sh
host:~$ source venv/bin/activate
host:~$ cd flownexus_workspace/lwm2m_server/server/django
host:lwm2m_server/server/django$ pip install -r requirements.txt
host:lwm2m_server/server/django$ ./django_start.sh
The Django server should now be up and running under the following URL:
``http://localhost:8000/admin``. The admin login is ``admin`` and the password
Expand All @@ -211,7 +211,7 @@ following command:

.. code-block:: console
host:root_dir/flownexus_workspace/lwm2m_server/server/django$ python manage.py test sensordata
host:~/flownexus_workspace/lwm2m_server/server/django$ python manage.py test sensordata
Found 2 test(s).
Creating test database for alias 'default'...
----------------------------------------------------------------------
Expand All @@ -228,11 +228,11 @@ The Leshan server can also run locally, without the need of a docker container.

.. code-block:: console
host:root_dir$ sudo apt update
host:root_dir$ sudo apt install openjdk-17-jdk maven
host:root_dir$ source venv/bin/activate
host:root_dir$ cd flownexus_workspace/lwm2m_server/server/leshan
host:root_dir/flownexus_workspace/lwm2m_server/server/leshan$ chmod +x leshan_build_run.sh && ./leshan_build_run.sh
host:~$ sudo apt update
host:~$ sudo apt install openjdk-17-jdk maven
host:~$ source venv/bin/activate
host:~$ cd flownexus_workspace/lwm2m_server/server/leshan
host:lwm2m_server/server/leshan$ ./leshan_build_run.sh
The Leshan server should now be up and running under the following URL: ``http://localhost:8080``.

Expand All @@ -247,8 +247,8 @@ be build with the following command:

.. code-block:: console
host:root_dir/flownexus_workspace/lwm2m_server$ west build -b nrf9161dk_nrf9160_ns fw_test/lwm2m_client -p
host:root_dir/flownexus_workspace/lwm2m_server$ west flash --recover
host:~/flownexus_workspace/lwm2m_server$ west build -b nrf9161dk_nrf9160_ns fw_test/lwm2m_client -p
host:~/flownexus_workspace/lwm2m_server$ west flash --recover
LwM2M Client Simulation
.......................
Expand All @@ -259,7 +259,7 @@ can be started in emulation with the following command:

.. code-block:: console
host:root_dir/flownexus_workspace/lwm2m_server$ chmod +x zephyr_build_run_sim.sh && ./zephyr_build_run_sim.sh
host:~/flownexus_workspace/lwm2m_server$ ./zephyr_build_run_sim.sh
*** Booting nRF Connect SDK zephyr-v3.5.0-3024-g7c3e830729b7 ***
[00:00:00.000,000] <dbg> net_lwm2m_engine: lwm2m_engine_init: LWM2M engine socket receive thread started
[00:00:00.000,000] <dbg> net_lwm2m_obj_security: security_create: Create LWM2M security instance: 0
Expand Down Expand Up @@ -325,7 +325,7 @@ The container can be build and started with the following commands:

.. code-block:: console
host:root_dir/flownexus_workspace/lwm2m_server/server$ docker compose build
host:~/flownexus_workspace/lwm2m_server/server$ docker compose build
[+] Building 0.5s (20/20) FINISHED docker:default
=> [leshan internal] load build definition from Dockerfile.leshan 0.0s
=> [leshan internal] load metadata for docker.io/library/openjdk:17-slim 0.4s
Expand All @@ -350,7 +350,7 @@ The container can be build and started with the following commands:
.. code-block:: console
host:root_dir/flownexus_workspace/lwm2m_server/server$ docker compose up
host:~/flownexus_workspace/lwm2m_server/server$ docker compose up
[+] Running 2/0
✔ Container server-leshan-1 Created 0.0s
✔ Container server-django-1 Created 0.0s
Expand Down

0 comments on commit 833b7d2

Please sign in to comment.