Metadata-Version: 2.1
Name: rak811
Version: 0.7.0.dev2
Summary: Interface for RAK811 LoRa module
Home-page: https://github.com/AmedeeBulle/pyrak811
Author: Philippe Vanhaesendonck
Author-email: philippe.vanhaesendonck@e-bulles.be
License: UNKNOWN
Description: # RAK811 Python 3 library for Raspberry Pi
        [![Latest Version](https://img.shields.io/pypi/v/rak811.svg)](https://pypi.org/project/rak811/)
        [![Build Status](https://travis-ci.org/AmedeeBulle/pyrak811.svg?branch=master)](https://travis-ci.org/AmedeeBulle/pyrak811)
        [![codecov](https://codecov.io/gh/AmedeeBulle/pyrak811/branch/master/graph/badge.svg)](https://codecov.io/gh/AmedeeBulle/pyrak811)
        
        ## About
        RAK811 Python 3 library and command-line interface for use with the Raspberry Pi LoRa pHAT.
        
        The library exposes the AT commands as described in the [RAK811 Lora AT Command User Guide V1.5](http://docs.rakwireless.com/en/LoRa/RAK811/Software_Development/RAK811%C2%A0LoRa%C2%A0AT%C2%A0Command%C2%A0V1.5.pdf).  
        The command-line interface exposes all API calls to the command line.
        
        Commands currently implemented:
        - System commands
        - LoRaWan commands
        - Radio
        
        Not implemented yet:
        - LoraP2P
        - Peripheral
        
        ## Requirements
        - A Raspberry Pi!
        - A RAK811 LoRa module ([PiSupply IoT LoRa Node pHAT for Raspberry Pi ](https://uk.pi-supply.com/products/iot-lora-node-phat-for-raspberry-pi))
        - On the Raspberry Pi the hardware serial port must be enabled and the serial console disabled (use `raspi-config`)
        - The user running the application must be in the `dialout` and `gpio` groups (this is the default for the `pi` user)
        
        ## Install the rak811 package
        The package is installed from PyPI:
        ```
        sudo pip3 install rak811
        ```
        
        The `pip3` command is part of the `python3-pip` package. If it is missing on your system, run:
        ```
        sudo apt-get install python3-pip
        ```
        
        ## Usage
        ### Quick start with The Things Network
        #### Register your device
        Register you device on [TheThingsNetwork](https://www.thethingsnetwork.org) using the unique id of your RAK811 module (Device EUI).  
        You can retrieve your Device EUI with the following command:
        ```
        rak811 hard-reset
        rak811 get-config dev_eui
        ```
        _Note_: the `rak811 hard-reset` command is only needed once after (re)booting your Raspberry Pi to activate the module.
        
        #### Hello World
        Send your first LoRaWan message wit the following python code snippet:  
        (The App EUI and App Key are copied verbatim from the TTN console)
        ```
        #!/usr/bin/env python3
        from rak811 import Mode, Rak811
        
        lora = Rak811()
        lora.hard_reset()
        lora.mode = Mode.LoRaWan
        lora.band = 'EU868'
        lora.set_config(app_eui='70B3D5xxxxxxxxxx',
                        app_key='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
        lora.join_otaa()
        lora.dr = 5
        lora.send('Hello world')
        lora.close()
        ```
        Your first message should appear on the TTN console!
        
        ### Next steps
        See the [example directory on GitHub](https://github.com/AmedeeBulle/pyrak811/tree/master/examples):
        - `api_demo.py`: demo most of the API calls
        - `otaa.py`: OTAA example
        - `abp.py`: ABP example
        
        To run the examples, first copy the `ttn_secrets_template.py` to `ttn_secrets.py` and enter your LoRaWan [TheThingsNetwork](https://www.thethingsnetwork.org) keys.
        
        _Note_: you do not need to `hard_reset` the module each time you run a script.
        However you must do it the first time after a (re)boot to activate the module.
        
        ## Command-line interface
        The `rak811` command exposes all library calls to the command line:
        
        ```
        $ rak811 --help
        Usage: rak811 [OPTIONS] COMMAND [ARGS]...
        
          Command line interface for the RAK811 module.
        
        Options:
          -v, --verbose  Verbose mode
          --help         Show this message and exit.
        
        Commands:
          abp-info            Get ABP info.
          band                Get/Set LoRaWan region.
          clear-radio-status  Clear radio statistics.
          dr                  Get/set next send data rate.
          get-config          Get LoraWan configuration.
          hard-reset          Hardware reset of the module.
          join-abp            Join the configured network in ABP mode.
          join-otaa           Join the configured network in OTAA mode.
          link-cnt            Get up & downlink counters.
          mode                Get/Set mode to LoRaWan or LoRaP2P.
          radio-status        Get radio statistics.
          recv-ex             RSSI & SNR report on receive.
          reload              Set LoRaWan or LoRaP2P configurations to default.
          reset               Reset Module or LoRaWan stack.
          send                Send LoRaWan message and check for downlink.
          set-config          Set LoraWAN configuration.
          signal              Get (RSSI,SNR) from latest received packet.
          sleep               Enter sleep mode.
          version             Get module version.
          wake-up             Wake up.
        ```
        
        Session example:
        ```
        $ rak811 -v reset lora
        LoRa reset complete.
        $ rak811 -v set-config app_eui=70B3D5xxxxxxxxxx app_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        LoRaWan parameters set
        $ rak811 -v join-otaa
        Joined in OTAA mode
        $ rak811 -v dr
        5
        $ rak811 -v dr 4
        Data rate set to 4.
        $ rak811 -v send Hello
        Message sent.
        No downlink available.
        $ rak811 -v send --port 4 --binary '01020211'
        Message sent.
        Downlink received:
        Port: 1
        RSSI: -56
        SNR: 31
        Data: 123456
        ```
        _Note_: for your first session after boot, you will need to do a `hard-reset` instead of a `reset lora` command to activate the module.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: test
