From 17306b892345d5d9e093ef8f84e1d057a8c15381 Mon Sep 17 00:00:00 2001 From: leandrofars Date: Thu, 22 Feb 2024 08:01:26 -0300 Subject: [PATCH] docs(readme): agent-simulator info + websockets agent info --- README.md | 14 ++++++++------ ...ebsockets.txt => oktopus-websockets-obuspa.txt} | 0 2 files changed, 8 insertions(+), 6 deletions(-) rename agent/{oktopus-0-websockets.txt => oktopus-websockets-obuspa.txt} (100%) diff --git a/README.md b/README.md index e4f8df4..bd6bbf6 100644 --- a/README.md +++ b/README.md @@ -233,17 +233,19 @@ user@user-laptop:~$ cd oktopus/frontend && npm i && npm run dev

  • Device test agent (obuspa):

    -

    You might follow the instructions to build obuspa at their repo QUICK_START_GUIDE.md and remember to define 'INCLUDE_PROGRAMMATIC_FACTORY_RESET' at 'vendor_defs.h' inside src/vendor folder, also advice you to build it with make tool.

    +

    + P.S: This guide in here is too simple, and at the same time hard, because you have to compile obuspa C code yourself, for an easier, more complete and real-world simulation of devices you might use Oktopus TR-369 Agent Simulator. +

    +

    Follow the instructions to build obuspa at their repo QUICK_START_GUIDE.md and remember to define 'INCLUDE_PROGRAMMATIC_FACTORY_RESET' at 'vendor_defs.h' inside src/vendor folder, also advice you to build it with make tool.

    You can customize 'oktopus-mqtt-obuspa.txt' accordingly to your needs, there you can change broker address, client password, and etc. '-i' option defines the interface your usp packets will go through, in this case it's localhost, also keep in mind that after you run obuspa if you made a change to 'oktopus-mqtt-obuspa.txt' and want it to take effect you must delete '/usr/local/var/obuspa/usp.db' file before running the agent again (docs provide you other methods to do it too).'-r' option defines the config file you want the agent to use.

    -

    Run agent:

    - 
    leandro@leandro-laptop:~/oktopus$ obuspa -p -v 4 -r agent/oktopus-mqtt-obuspa.txt -i lo
    +

    Run MQTT agent:

    + 
    user@user-laptop:~/oktopus$ obuspa -p -v 4 -r agent/oktopus-mqtt-obuspa.txt -i lo
    +

    Run Websockets agent:

    + 
    user@user-laptop:~/oktopus$ obuspa -p -v 4 -r agent/oktopus-websockets-obuspa.txt -i lo

    Obuspa has a lot of info and docs at their repo, which shows you many options to set your environment and customize agent to your embedded project. This basic agent has the purpose to test oktopus connection and shows an idea of how it's like with true devices, although with those, you're able to explore much more parameters and execute lots of configurations. Obuspa has default parameters and mocked info:

    • -

    - In case you want a more complete and real-world simulation of devices you might use Oktopus TR-369 Agent Simulator. -

    -------------------------------------------------------------------------------------------------------------------------------------------------------- diff --git a/agent/oktopus-0-websockets.txt b/agent/oktopus-websockets-obuspa.txt similarity index 100% rename from agent/oktopus-0-websockets.txt rename to agent/oktopus-websockets-obuspa.txt