From 991bedec67cb8b2edb423396e9140c3d7f1d5a22 Mon Sep 17 00:00:00 2001 From: Carlos Alatorre Date: Mon, 30 Oct 2023 16:45:53 -0600 Subject: [PATCH] Update Readme and add wiki links Signed-off-by: Carlos Alatorre --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index dd87404..a8da688 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) @@ -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)