cayenne_lpp

Elixir library for Cayenne Low Power Payload (LPP) format

Installation

The package can be installed by adding cayenne_lpp to your list of dependencies in mix.exs:

defp deps do
  [{:cayenne_lpp, "~> 0.1.0"}]
end

Usage

alias Cayenne.LPP.Payload
alias Cayenne.LPP.Type.{Temperature, RelativeHumidity}

payload =
  Payload.new()
  |> Payload.add(1, Temperature.new(28.3))
  |> Payload.add(2, RelativeHumidity.new(40.5))

# Payload as String: "0167011B02680195"
payload
|> Payload.to_string()
|> IO.inspect(label: "Payload as String")

# Payload size (in bytes): 8
payload
|> Payload.size()
|> IO.inspect(label: "Payload size (in bytes)")

Inspiration

This library has been inspired by the following list of articles, videos and libraries written in other programming languages:

• Articles
  • OMA LightweightM2M (LwM2M) Object and Resource Registry
  • Cayenne Low Power Payload
  • Cayenne LPP 2.0
  • Cayenne LPP @ loranow.com
  • Getting Started with the Raspberry Pi LoRa Node pHAT
• Libraries
  • https://github.com/myDevicesIoT/CayenneLPP (C++)
  • https://github.com/TheThingsNetwork/arduino-device-lib (C)
  • https://github.com/OlegZv/Python-CayenneLPP (Python)
  • https://github.com/ctron/cayenne-lpp (Java)
• Videos
  • How to: Payload Functions
  • Eric Ptak - Payload formats for LPWAN Applications
• Platforms
  • Cayenne Cloud by myDevices
  • TheThingsNetwork

Hardware

While developing this library, the following hardware has been used to test the integration with TheThingsNetwork and Cayenne Cloud:

• Raspberry Pi 3 Model B+
• IoT LoRa Node pHAT for Raspberry Pi (Multi Frequence)
• RAK7258 Micro Gateway

TODOs

• Publish to hex.pm
• Publish docs to hexdocs.pm
• Support decoding, not just encoding
• Add example using circuits_uart

License

This software is licensed under the MIT license