About plugins

[chrono1111]

I want to code a plugin for Sideband to communicate with ATak. However, I can't find any documentation on the Sideband and Reticulum APIs. Where is the documentation?

[kc1awv]

Reticulum's API is pretty well documented. Reticulum API Reference. As far as Sideband is concerned, it's an app in itself that runs on Reticulum networks, and implements LXMF. What would be the use case of adding ATAK to Sideband? Just transferring messages?

[chrono1111]

As well as relaying telemetry, in an emergency situation coordination is a very important reticulum that allows for networks to be set up quickly and easily across a large number of multiple different devices. By allowing sensor information as well as communications to be relayed it can allow people to respond more efficiently in an emergency situation. Sideband already exists and of all the reticulum clients it has one for just every commonly used operating system; moreover, it also has plug-in support so it for my point of view makes the most logical choice for this setup.

[kc1awv]

So, I think I understand the concept, but not the 'why' ATAK would need to talk to a Sideband user. Why not just have all clients run ATAK, and use Reticulum as the transport? Or, even just use ATAK's own transport (I assume it has its own network protocol anyway) and attach a LoRa modem to the phone? You could alternatively use an RNode as a simple KISS interface, if ATAK supports that.

I suppose I'm just not understanding the Sideband part, so I'll let someone else help out here.

[chrono1111]

No, ATAK does not have a network protocol. It uses plugins to support other network protocols. For example, the military has highly over-the-top radios that natively support ATAK. However, those radios are too expensive for the average person to purchase in civilian space, and whether they would be legal is unclear. I'm using Sideband because it's an existing app that does what I want. All I have to do is teach it to talk to ATAK. As your argument, could you write a program or plug it in to have it directly speak to the Reticulum? Yes. However, that's a bit beyond my meager coding skills.
I could write a plugin that relays the required information to the ATAK API. Moreover, The server feature allows a person to make RNodes with their smartphone. This makes it easier for other people to set up. Finally, most people commonly use Meshtastic for this purpose. However, is Meshtastic a good Project. The Reticulum is more flexible and easier to use. You don't have to use an RNode if you don't want to. You can use your phone's Wi-Fi, Bluetooth, or any other form of connectivity. If you'd be willing to help me, we could write a program that does this stand-alone. I've got no problem with that solution. As I said previously, it's a little beyond my coding skills. It's easier to use something that already exists Rather than reinvent the wheel. Remember, despite the name ATAK at its core, it Is simply an over-the-top mapping and coordination tool. That's it. It doesn't do anything else without something else to give it the data required to do that purpose. Do you have any other questions?

[markqvist]

Here's the full Reticulum API reference. You can also find several basic example programs here. Those are also included in the manual, but probably easier to access from the source repository. That should get you started with the basic concepts on how to write Reticulum-based programs.

There's basic LXMF example code here, but the code for Sideband, MeshChat and nomadnet are also worth looking at for details on the more advanced stuff.

For Sideband plugins specifically, there's a whole range of example plugins available right here for you to build on.

For more info on all of the different sensor types supported, have a look at the Telemeter source code from the Sideband repository.

Btw, there's also native support in Sideband for exporting received/collected telemetry to MQTT servers.

[chrono1111]

Thank you so much for your help. I appreciate that. On a side note, I am a big fan of your sideband projects. It and the reticulum network have a lot of potential. 👍

[LinuxinaBit]

The RTAK project might be worth checking out:
https://www.fau.edu/engineering/senior-design/projects/fall2024/rtak-integrating-android-team-awareness-kit-atak/
https://cdn.prod.website-files.com/64c9456e396925dddd2b86e8/672a6fb7027a41d993c05da5_TeamRTAK_CIVXSMARTCITIES%20-%20Jk%20Jake.pdf

@jkjake:matrix.org in the Matrix channel has some affiliation iirc.

[LinuxinaBit]

Also some FreeTAKServer developers (namely @brothercorvo - @k0rv0:envs.net on Matrix) appear to be working on a Reticulum integration of some kind as well.

[chrono1111]

I'll check it, thank you that could be a good solution

[brothercorvo]

We are working on a server to server implementation . A better version of a federation

[markqvist]

If you're interested in making your own plugin @chrono1111, you should definitely do it. Having various different solutions from different people only makes things better for everyone, and as far as I know, the FreeTAK stuff is much more on the idea/concept stage, than anything actually functional/usable at this point.

[chrono1111]

I'm still planning on doing it. Even if no one uses the plug in it's at least some practice coding so that's something. You never know people might like the plug in and use it. Just because I think it's a good idea doesn't necessarily do and as you said having more than one option is never a bad thing at least I don't think so. Thank you for all of your assistance, ideas and thoughts I am grateful. 🙂