Skip to content

Commit

Permalink
README Minor changes + more beautiful 🍠
Browse files Browse the repository at this point in the history
  • Loading branch information
Overdrivr committed Feb 7, 2016
1 parent ac7ad96 commit d0bf787
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,23 @@ This tool enables superior communication with any embedded device.
This command line interface is for you if:

* you are using `printf` to debug your application (and looking for a better way)
* you need a decent and reliable communication protocol for your application, that will run both on desktop and embedded
* you are all the time re-writing custom protocols on top of the serial port for each new application (and hating it)
* you need a *reliable* and *error-tolerant* communication protocol for your application, that will run both on desktop and embedded
* you need to finely tune your application, but so far you are compiling/flashing the code all over again after each parameter change
* you want to plot parameters of your application in real-time in a clean, fast and reliable way
* you want to *plot* parameters of your application in *real-time* in a clean, fast and reliable way
* your embedded device has very limited resources and will tolerate only a fast and lightweight communication library
* you have found some other communication protocol but cannot manage to integrate it on your specific device

If you agree with any of the above points, this application is for you.
If you recognize yourself with any of the above points, this application is for you.

## Overview
pytelemetry-cli (this repo) is a command line interface. It provides a set of commands to connect to a device, read, plot and write data on it.
pytelemetry-cli relies on the [pytelemetry](https://github.com/Overdrivr/pytelemetry)
[![PyPI version](https://badge.fury.io/py/pytelemetry.svg)](https://badge.fury.io/py/pytelemetry) to implement the specific communication protocol.
pytelemetry-cli (this repo) is a **command line interface**. It provides a set of commands to connect to a device, read, plot and write data on it.
pytelemetry-cli relies on `[pytelemetry](https://github.com/Overdrivr/pytelemetry)`
[![PyPI version](https://badge.fury.io/py/pytelemetry.svg)](https://badge.fury.io/py/pytelemetry)
to implement the specific communication protocol.

The communication protocol is also available in a C library ([telemetry](https://github.com/Overdrivr/pytelemetry)), specifically designed to run on all platforms and be as light as possible.
The communication protocol is also available in a C library called `[telemetry](https://github.com/Overdrivr/pytelemetry))`
that is specifically designed to run on all platforms and to be as light as possible.

![Overview](https://raw.githubusercontent.com/Overdrivr/pytelemetrycli/master/overview.png)

Expand Down

0 comments on commit d0bf787

Please sign in to comment.