Home

This wiki will guide you on how to setup and use telemetry in your next embedded project.

telemetry is a communication protocol, meant to run on any embedded platform like Arduino or ARM Mbed. It offers (among many other things) an alternative to serial.printf that is smarter, lighter and much more powerful.

If you intend to remotely control or monitor an embedded application from your laptop, this is the perfect tool for the job, combined with the appropriate software on your computer.

todo: schematic of a simple overview telemetry, pytelemetry, pytelemetry CLI

Note: Wiki in writing. Feel free to send comments or propose modifications.

Setup

• ARM Mbed
• Arduino
• Setup on a new platform

Get started for embedded platforms

• Telemetry with Mbed and C++
• Telemetry with Arduino to be done
• Telemetry with C api
• Advanced features

Get started for remote debug and remote control

From your computer, debug any telemetry enabled embedded program, or take control remotely. Opening real-time plots is only a command away.

• Fast debugging with the command line interface (todo)
• Writing a python application for controlling an embedded device (todo)

General knowledge

• Overview of the library (note: needs to be more approachable)
• Protocol description
• All the good stuff inside Telemetry
• List of supported platforms
• Good practices (Must-read !) in writing

Troubleshooting

• Frequently Asked Questions todo

Examples and projects

• List of official examples
• List of projects using telemetry

Contributing

• Guidelines (todo)
• Setup your environment todo
• Description of the build and test flow (must read for contributors)

Hall of fame

• Contributors
• Projects