sbd-rs

Native rust library to read and write Iridium Short Burt Data (SBD) messages, and an executable that exposes some of the library's functionality.

Building the executable

To build the sbd executable, you need rust. Once you have rust, download the source from github:

$ git clone https://github.com/gadomski/sbd-rs.git

Build with cargo:

$ cd sbd-rs
$ cargo build --release

As of this writing, the release version of cargo does not include an install comand. To use the executable, you have a couple options:

$ # Play it where it lies...
$ target/release/sbd --help
$
$ # ...or link it to a directory on your path
$ ln -s $PWD/target/release/sbd ~/local/bin/sbd
$ sbd --help

Or whatever.

Using sbd serve as a daemon

The executable includes a couple of powers, including a "run-forever" server for receiving Iridium SBD DirectIP messages and storing thosem messages to the filesystem. This sbd serve power does not include any sort of daemonization; you have to roll your own. I've provided an example init.d script in init.d/iridiumd to get things started.

Using the library

Include the following in your Cargo.toml:

[dependencies]
sbd = "0.1.0"

Documentation

The documentation is available online or by building the docs with cargo doc.

What is Iridium? What is SBD?

Iridium can refer to both a satellite network and the private company that manages that network. Iriduim supports a variety of services, including phone communications, dial-up modems, and (our area of interest) a type of "packet" communication called Short Burst Data (SBD). SBD messages are composed of header information, including time of transmission and modem number, and a payload, which is an arbitrary set of bytes. SBD payloads can be restricted to as little as 340 bytes per message, or can allow 1960 bytes per message or more.

Iridium modems with SBD capabilities can both send messages (called Mobile Originated or MO messages) and receive messages (called Mobile Terminated or MT). At this time this library focuses on Mobile Originated (MO) messages, as the author has no use for MT messages. Pull requests for MT support are welcome.

Mobile Originated (MO) messages are sent from an Iridium modem to the Iridium "gateway", which processes messages and forwards them on for delivery to one more more endpoints. Endpoints are configured through a web interface, and can come in one of two flavors: email endpoints, where the message is sent as a MIME email attachment, and DirectIP endpoints, where the messages are delivered over a TCP connection to an IP address and port.

This library includes facilities to read SBD messages stored on the filesystem, and to parse SBD messages coming in on a TcpStream.

License

This code is available under the MIT license, a full text of which can be found in LICENSE.txt inside this repository.

Contributing

Please open issues and/or pull requests through the github interface.

Authors

This code was cobbled together by Pete Gadomski pete.gadomski@gmail.com.