https://github.com/pelioniot/mbed-edge-examples
The Mbed Edge protocol translator examples
https://github.com/pelioniot/mbed-edge-examples
ble libmosquitto lwm2m lwm2m-protocol mqtt protocol-translator
Last synced: 10 months ago
JSON representation
The Mbed Edge protocol translator examples
- Host: GitHub
- URL: https://github.com/pelioniot/mbed-edge-examples
- Owner: PelionIoT
- License: apache-2.0
- Created: 2018-10-19T12:53:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-16T13:07:01.000Z (over 1 year ago)
- Last Synced: 2024-12-16T13:53:38.321Z (over 1 year ago)
- Topics: ble, libmosquitto, lwm2m, lwm2m-protocol, mqtt, protocol-translator
- Language: C
- Homepage:
- Size: 554 KB
- Stars: 4
- Watchers: 11
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Edge Protocol Translator Examples
This repository contains the Protocol Translator examples for the Edge.
## pt-example
Pt-example is a basic example of the C-API and pt-client usage.
## mqttpt-example
`mqttpt-example` is an example of a protocol translator that connects to endpoints using MQTT. It can be used
without real MQTT hardware using provided Mosquitto MQTT simulator scripts. The endpoints may
publish for example temperature and humidity values to Device Management.
NOTE! This requires Eclipse's Mosquitto - see installation info: https://mosquitto.org/download/
## blept-example
The `blept-example` is a protocol translator reference implementation for use with Bluetooth Low Energy (BLE) devices that implement a Bluetooth Low Energy Generic Attributes (GATT) server. It connects to BLE devices and translates their GATT services and characteristics into Open Mobile Alliance (OMA) Lightweight Machine to Machine (LwM2M) Objects and Resources.
## simple-js-examples
The `simple-js-examples` are different from the rest of the examples. Instead of using the provided `pt-client`
library these examples use Edge Core protocol translator and management API directly.
These are examples on how a protocol translator or management API application can be created using Javascript.
See the [simple-js-examples/README.md](simple-js-examples/README.md) for instructions.
## c-api-stress-tester
This example tests the robustness and thread safeness of Protocol API C-API interface
# Build and run the examples
1. Directly on Ubuntu 22.04 or 20.04 or
1. Using Docker.
## Using Ubuntu 22.04 or 20.04:
1. Dependencies
Following dependencies are needed in the build system.
* librt
* libstdc++
* OPTIONAL for mqttpt-example: libmosquitto
Install these (using `sudo` typically):
```
sudo apt-get update
sudo apt-get install build-essential cmake git libc6-dev \
libmosquitto-dev mosquitto-clients libglib2.0-dev \
doxygen
```
NOTE! Mosquitto might not be available directly in your distribution (for example Ubuntu 22.04),
see https://mosquitto.org/download/ for more installation information.
1. Preparing all the sources
Please run the following to clone and update all the git modules.
```
git submodule update --init --recursive
```
1. Building
Makefile has options to build any of the pt-examples separately, or all at the same.
To make all examples without debug information and with default trace level, run
```
make build-all-examples
```
It will build the examples to `build/bin` directory.
To make all examples with debug information and debug trace level, run
```
make build-all-examples-debug
```
It will build the examples to `build-debug/bin` directory.
To make all examples with ThreadSanitizer and debug trace level, run
```
make build-all-examples-sanitize
```
It will build the examples to `build-sanitize/bin` directory.
Running `make all` will generate `build`, `build-debug` and `build-sanitize` directories.
Please note following:
`mqttpt-example` will not be built if the `libmosquitto` is not installed.
For more examples, see the rules in the Makefile.
1. Running the examples
Each of the examples has a `README.md` file that documents how to run the example.
## Using Docker
Before building the docker image, fetch the dependencies:
```
git submodule update --init --recursive
```
### pt-example
Build:
```
docker build -t pt-example:latest -f ./Dockerfile.pt-example .
```
Run:
```
docker run -v /tmp:/tmp pt-example:latest
```
### simple-js-examples/simple-pt-example
Build:
```
docker build -t simple-pt-example:latest -f ./Dockerfile.simple-pt-example .
```
Run in interactive mode:
```
docker run -v /tmp:/tmp -it simple-pt-example:latest
```