Skip to content

Commit

Permalink
Merge pull request #47 from xpeqex/master
Browse files Browse the repository at this point in the history
Update Readme and add wiki links
  • Loading branch information
sabas1080 authored Oct 30, 2023
2 parents f125835 + 991bede commit 0ca3459
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
![LibraryBuild](https://github.com/ElectronicCats/CayenneLPP/workflows/LibraryBuild/badge.svg?branch=master)
# CayenneLPP _by Electronic Cats_ - Library for Arduino

# CayenneLPP
![LibraryBuild](https://github.com/ElectronicCats/CayenneLPP/workflows/LibraryBuild/badge.svg?branch=master)

This is an Arduino Library for Arduino Compatible with Cayenne Low Power Payload with Extended Data Types.

## Introduction

CayenneLPP is a format designed by [myDevices](https://mydevices.com) to integrate LoRaWan nodes into their [IoT Platform](https://mydevices.com/capabilities). It is used to send sensor data in a packed way to [The Things Network platform](https://www.thethingsnetwork.org). You can read more on [myDevices CayenneLPP](https://docs.mydevices.com/docs/lorawan/cayenne-lpp)

## Description
Expand All @@ -14,17 +12,14 @@ CayenneLPP format is a quite well-optimized way to send sensor data over low bit

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

#### ⚠ Warning ⚠
> ⚠ 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.

## Dependencies
## Wiki and Getting Started
For more information please visit: [**Getting Started in our Wiki**](https://github.com/ElectronicCats/CayenneLPP/wiki)

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.

## API

See [API.md](API.md).

## References

* [Cayenne Low Power Payload](https://mydevices.com/cayenne/docs/#lora-cayenne-low-power-payload)
Expand All @@ -40,6 +35,6 @@ Electronic Cats invests time and resources in providing this open-source design

## License

Based in the work of [Johan Stokking](https://github.com/TheThingsNetwork/arduino-device-lib).
Based on the work of [Johan Stokking](https://github.com/TheThingsNetwork/arduino-device-lib).

The MIT License (MIT)

0 comments on commit 0ca3459

Please sign in to comment.