Skip to content

Commit

Permalink
Merge pull request #50 from xpeqex/master
Browse files Browse the repository at this point in the history
feat(docs):Update README.md
  • Loading branch information
sabas1080 authored Apr 8, 2024
2 parents 0dd193c + 2d53d4b commit cec1670
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,30 @@ CayenneLPP is a format designed by [myDevices](https://mydevices.com) to integra

CayenneLPP format is a quite well-optimized way to send sensor data over low bit rate connection, like LoRa. You may find, probably, a better way for your specific project but CayenneLPP is a standardized and proven format that packs data in a sufficient way. It implements basic sensor types specified by [OMA SpecWorks](https://www.omaspecworks.org), formerly IPSO Alliance.

<a href="https://github.com/ElectronicCats/CayenneLPP/wiki">
<img src="https://github.com/ElectronicCats/CayenneLPP/assets/139595394/a17c04ef-8c5c-493c-bf1a-f3dd4037408a" />
</a>
<p align=center>
<a href="https://github.com/ElectronicCats/CayenneLPP/wiki">
<img src="https://github.com/ElectronicCats/CayenneLPP/assets/139595394/a17c04ef-8c5c-493c-bf1a-f3dd4037408a" width="200" height="104" />
</a>
</p>

It supports multichannel data, which means that you can use it on multisensor devices.

> ⚠ Warning ⚠
This version of the library includes several IPSO data types not included in the original work by [Johan Stokking](https://github.com/TheThingsNetwork/arduino-device-lib) or most of the forks and side works by other people, **these additional data types are not supported by myDevices Cayenne**. In addition, it includes a fully backward-compatible decoder in JavaScript, suitable for implementations with NodeRED or TTN, for instance.

## Wiki and Getting Started
For more information please visit: [**Getting Started in our Wiki**](https://github.com/ElectronicCats/CayenneLPP/wiki)
> [!Warning]
> This version of the library includes several IPSO data types not included in the original work by [Johan Stokking](https://github.com/TheThingsNetwork/arduino-device-lib) or most of the forks and side works by other people, **these additional data types are not supported by myDevices Cayenne**. In addition, it includes a fully backward-compatible decoder in JavaScript, suitable for implementations with NodeRED or TTN, for instance.
When using the decoder, you must install the [ArduinoJson 6.X](https://arduinojson.org/) library. You can find it in both the Arduino IDE and PlatformIO library managers.

## How to contribute <img src="https://electroniccats.com/wp-content/uploads/2018/01/fav.png" height="35"><img src="https://raw.githubusercontent.com/gist/ManulMax/2d20af60d709805c55fd784ca7cba4b9/raw/bcfeac7604f674ace63623106eb8bb8471d844a6/github.gif" height="30">
Contributions are welcome!

Please read the document [**Contribution Manual**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-contribution-manual.md) which will show you how to contribute your changes to the project.

✨ Thanks to all our [contributors](https://github.com/ElectronicCats/CayenneLPP/graphs/contributors)! ✨

See [**_Electronic Cats CLA_**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-cla.md) for more information.

See the [**community code of conduct**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-community-code-of-conduct.md) for a vision of the community we want to build and what we expect from it.

## References

* [Cayenne Low Power Payload](https://mydevices.com/cayenne/docs/#lora-cayenne-low-power-payload)
Expand Down

0 comments on commit cec1670

Please sign in to comment.