Skip to content

Commit 50a5a1b

Browse files
committed
Merge branch 'develop' of https://github.com/telemetryjet/telemetryjet-arduino-sdk into develop
2 parents 9170855 + b42b29c commit 50a5a1b

File tree

1 file changed

+9
-18
lines changed

1 file changed

+9
-18
lines changed

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
11
# TelemetryJet Arduino SDK
22

3-
---
4-
5-
The TelemetryJet Arduino SDK is a lightweight library for communicating sensor and control data to or from microcontrollers. The Arduino SDK is designed primary for ease-of-use, with a simple, flexible API for instantly getting data from your embedded device. The SDK provides a high-level abstraction for getting and setting data and events, and handles the low-level functionality of transmitting those events.
6-
7-
The TelemetryJet CLI can natively ingest and stream data from the Arduino SDK without any setup. We also provide bindings for the SDK in several languages for use in your own software.
8-
9-
The TelemetryJet Arduino SDK is an excellent solution if you are interacting with a single microcontroller in your project. The SDK can be used with or without TelemetryJet itself.
3+
[![arduino-library-badge](https://www.ardu-badge.com/badge/TelemetryJet.svg?)](https://www.ardu-badge.com/TelemetryJet)
4+
![version-badge](https://img.shields.io/github/v/release/telemetryjet/telemetryjet-arduino-sdk)
5+
![commit-activity-badge](https://img.shields.io/github/last-commit/telemetryjet/telemetryjet-arduino-sdk)
6+
![license-badge](https://img.shields.io/github/license/telemetryjet/telemetryjet-arduino-sdk)
107

8+
The TelemetryJet Arduino SDK is a lightweight, flexible library for communicating with microcontrollers. The Arduino SDK is a wrapper around [MessagePack](https://msgpack.org/index.html) that allows you to send and receive data points using a high-level API.
119

1210
### Features
13-
- Bidirectional communication; send commands and/or data points in either direction
14-
- Send and receive data, and cache latest data points on the Arduino SDK
15-
- Cache expiration times
16-
- Send and receive one-off events
17-
- Operates over software or hardware serial, independent of transport mechanism
18-
- 100% free and open source
11+
- **Bidirectional communication**: The SDK encodes and decodes data with MessagePack over a serial connection, providing a robust telemetry link that requires minimal setup. Easily send or receive data and configure transmission rate, error checking, and other serial communication settings.
1912

13+
- **Pub/sub messaging & caching**: Filter incoming data points, so your microcontroller only stores values you’ve selected. Data you’ve subscribed to caches locally on your device.
2014

21-
### Philosophy
22-
The SDK takes an opinionated approach to message parsing and provides high-level functionality.
23-
The TelemetryJet Arduino SDK is built on top of [MessagePack](https://msgpack.org/index.html), which provides an efficient serialization protocol for arbitrary data. On top of MessagePack, the SDK adds
24-
an API for bidirectional communication, a data point cache, one-off event triggers, and more.
15+
- **Easy integration with any software**: The SDK sends pure MessagePack structures. You can easily parse messages in any program using [MessagePack’s language bindings](https://msgpack.org/index.html), or use the TelemetryJet CLI to stream data into other data sources without code.
2516

2617
### Documentation
2718
Full documentation for the TelemetryJet Arduino SDK is provided on the [TelemetryJet Documentation Site](https://docs.telemetryjet.com/arduino_sdk/).
2819

2920
### Compatibility
3021

31-
The TelemetryJet Arduino SDK requires Arduino IDE 1.5.x+.
22+
The TelemetryJet Arduino SDK requires Arduino IDE 1.5.x+.

0 commit comments

Comments
 (0)