https://github.com/jeija/librenard
Reverse Engineered Sigfox Stack - Library
https://github.com/jeija/librenard
microcontroller reverse-engineering sdr sigfox
Last synced: about 1 month ago
JSON representation
Reverse Engineered Sigfox Stack - Library
- Host: GitHub
- URL: https://github.com/jeija/librenard
- Owner: Jeija
- Created: 2018-09-27T12:49:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-03T19:26:18.000Z (almost 4 years ago)
- Last Synced: 2025-02-28T10:18:08.372Z (about 2 months ago)
- Topics: microcontroller, reverse-engineering, sdr, sigfox
- Language: C
- Size: 91.8 KB
- Stars: 23
- Watchers: 10
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `librenard` - Sigfox Protocol Library
`librenard` is a portable library written in the C programming language that implements [Sigfox](https://www.sigfox.com/) uplink and downlink frame encoding and decoding. It aims to be an open source replacement for [Sigfox's proprietary device library](https://build.sigfox.com/sigfox-library-for-devices). It can be used in conjuction with the CLI frontend [`renard`](https://github.com/Jeija/renard) and the SDR physical layer [`renard-phy`](https://github.com/Jeija/renard-phy) or be embedded in your custom IoT application on any microcontroller platform. For instance, [`renard-phy-s2lp`](https://github.com/Jeija/renard-phy-s2lp) can be used to build a completely open-source Sigfox device based on `librenard` and STMicroelectronics' S2-LP ultra-low power transceiver chip.
It has been tested on many platforms including Linux, macOS, Android (x86 and ARM), STM32L0 and ESP32 and should also be portable to other operating systems and various microcontroller platforms.
## Installation and Compilation
* Clone this repository:
```
git clone https://github.com/Jeija/librenard
```
* `librenard` has no dependencies other than a working compiler and `make`. Compile using:
```
cd librenard
make
```
* This generates the static library file `librenard.a` which can be linked to your application or the `renard` CLI frontend.
## Embedding
`librenard` is designed to be statically linked with your own application, so that it can be embedded into microcontroller code or into other tools.
For using `librenard` you will have to tell your compiler about the path to the `librenard.a` static library file and about the path to the header includes.
Most compilers (shown here: `gcc`) use the following options to specify library and header locations:
```
gcc -I librenard/src librenard/librenard.a -o out
```
See [`renard`](https://github.com/Jeija/renard) for an example of how to incorporate `librenard` into your application and build system.
Please refer to the [documentation](#documentation) for information on how to include the `librenard` headers in your source code and for information on how to use the `librenard` functions.
## Documentation
Up-to-date documentation is always available online at [Read the Docs](https://librenard.readthedocs.io).
You can build the documentation yourself by following these steps:
* Clone the `librenard` if you have not already (see [Installation and Compilation](#installation-and-compilation))
* `librenard` uses [sphinx](http://www.sphinx-doc.org), [doxygen](http://www.doxygen.org/) and [breathe](https://github.com/michaeljones/breathe) for documentation. You will need to install these dependencies.
* Generate HTML documentation files:
```
cd librenard/doc
make html
```
* Open `doc/_build/html/index.html` in a web browser
## TODOs
* Implement empty Uplink frames (currently only supports 1-bit uplinks at minimum)
* Implement [encrypted mode](https://www.disk91.com/2018/technology/sigfox/stop-telling-me-sigfox-is-clear-payload-for-real-youre-just-lazy/)
* Implement support for OOB frames
* Implement support for multiple RC Zones (...or only do that on PHY layer?)
* Add Monarch support?
* Implement support for repeater-like applications (evalute and expose repeater flag)
* Once the satellite is up and running, implement Admiral LEO