Metadata-Version: 2.1
Name: nooploop-uwb
Version: 0.0.1
Summary: Nooploop LinkTrack UWB Products Python API.
Home-page: https://github.com/JaySurplus/nooploop_uwb
Author: JaySurplus
Author-email: znznbest2004@gmail.com
License: MIT
Download-URL: https://github.com/JaySurplus/nooploop_uwb/releases
Description: # **Nooploop LinkTrack UWB**
        
        ## **Overview**
        Unofficial Nooploop LinkTrack UWB Devices Python API. It parses Nooploop LinkTrack UWB Protocols.
            
        * Nooploop Homepage: [https://www.nooploop.com/](https://www.nooploop.com/)
        
        ## Supported Devices
        | Product | Supported? | Protocols |
        | :-----: | :--------: | :-------: |
        | LinkTrack |  **NO**  |     -     |
        | LinkTrack AOA | **Partial** | NLink_LinkTrack_AOA_Node_Frame0 |
        
        ## Installation
        
        ### System
        
        **Ubuntu20.04** (Ubuntu18.04, Windows Should also work fine.)
        
        ### Prerequisites (If you want to build from source)
        
        * Setuptools,
        * Wheel
            
        Install with one line.
            
        ```bash
        (your terminal)$: pip install --upgrade pip setuptools wheel
        ```
        
        
        ### Dependencies
        
        pyserial >= 3.5 (Tested with 3.5. Lower version should works fine.)
        
        ### Install
        * **Build From Source**
        
        1. Download Source Code.
        2. Change directory to source code root.
        3. Running Command in your terminal
        ```bash
        $: python setup.py sdist bdist_wheel
        ```
        4. Change directory to `(source code root)/dist`. Run
        ```bash
        (source code root)$: pip install ./Nooploop_UWB-0.0.1-py3-none-any.whl
        ```
        5. You are all set.
        
        * **Install From Release**
        
        1. Download `Nooploop_UWB-0.0.1-py3-none-any.whl`
        2. Change directory to `(Your downloads directory)`. Run
        ```bash
        (Your downloads directory)$: pip install ./Nooploop_UWB-0.0.1-py3-none-any.whl
        ```
        3. You are all set.
        
        ## Run Example
        
        1. Change directory to `(source code root)/examples`. Run
        ```bash
        (source code root)$:python example.py
        ```
        
        2. Outputs:
        
        ```JSON
        {
            "role": 2,
            "id": 0,
            "voltage": 4.364,
            "node_quantity": 1,
            "nodes": {
                "0": {
                    "role": 1,
                    "id": 0,
                    "distance": 1.327,
                    "angle": 57.66,
                    "fp_rssi": -84.5,
                    "rx_rssi": -80.0
                }
            }
        }
        ```
        
        
        ## Usage
        
        ```python
        from nooploop_uwb import aoa
        
        if __name__ == '__main__':
            # Create AOA Instance with `config.json`
            UWB_AOA = aoa.AOA('config.json')
        
            # or create instance by passing port, baudrate parameters.
            # UWB_AOA = aoa.AOA(port='/dev/ttyUSB1', baudrate=9216000)
        
            try:
                while True:
                    # __str__ method.
                    print(UWB_AOA)
        
                    # Get data in JSON format.
                    json_data = UWB_AOA.get_data_json()
        
                    # Get data in dictionary format.
                    dic_data = UWB_AOA.get_data()
        
            except KeyboardInterrupt:
                print("Press Ctrl-C to terminate while statement")
                UWB_AOA.terminate()
        ```
        
        ```JSON
        # config.json
        {
            "port": "/dev/ttyUSB1",
            "baudrate": 921600  
        }
        ```
        
        ## License
        This project is licensed under the MIT License. Copyright 2021 ***JaySurplus***
Platform: Ubuntu 20.04
Platform: Ubuntu 18.04*
Platform: Ubuntu 16.04*
Platform: Windows 10
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
