Metadata-Version: 2.1
Name: jocasta
Version: 0.2.1
Summary: Fetch sensor data.
Home-page: https://github.com/chrishannam/jocasta
Author: Chris Hannam
Author-email: ch@chrishannam.co.uk
License: UNKNOWN
Description: # Jocasta
        Library to extract data from serial and send it various services.
        
        # Quick Start
        ## Installation
        `pip3 install jocasta`
        
        ## Basic Home Config File
        
        Create a directory in your home directory to store the config file. You can pass in a file
        at run time but this is the quick start.
        
        ```
        cd ~
        mkdir .config
        cd .config
        ```
        
        Create a file called `jocasta_config.ini` and copy and paste the following into the depending on which services you want.
        
        ```
        [io_adafruit]
        username = username
        key = key
        feeds = temperature,light,humidity
        measurements = temperature,light,humidity
        
        [influxdb]
        host = 192.168.1.100
        port = 8086
        password = admin
        username = admin
        database = greenhouses
        
        [file_system]
        file_name = /tmp/sensor_data.json
        
        [temperature_ranges]
        maximum = 55.0
        minimum = -10.0
        ```
        
        ## Running
        Start `jocasta` by add the path of your serial device.
        
        ### OSX
        Command and output
        ```
        $ jocasta /dev/tty.usbserial-14230
        ╒═════════════╤══════════╤══════════╤══════════╤════════╕
        │ Temperature │ Location │ Moisture │ Humidity │ Light  │
        ├─────────────┼──────────┼──────────┼──────────┼────────┤
        │ 23.2        │ office   │ 568      │ 61.2     │ 5800.0 │
        ╘═════════════╧══════════╧══════════╧══════════╧════════╛
        ```
        
        ###  Raspberry Pi / Linux
        Command and output
        ```
        $ jocasta /dev/ttyUSB0
        ╒═════════════╤══════════╤══════════╤══════════╤════════╕
        │ Temperature │ Location │ Moisture │ Humidity │ Light  │
        ├─────────────┼──────────┼──────────┼──────────┼────────┤
        │ 23.2        │ office   │ 568      │ 61.2     │ 5800.0 │
        ╘═════════════╧══════════╧══════════╧══════════╧════════╛
        ```
        
        # Running
        A config file can supplied to the command line call using the following:
        ```
        jocasta /dev/tty.usbserial-14230 /path/to/config.ini
        ```
        
        # Supported Services
        Services and things Jocasta can send data to.
        
        ## InfluxDB - https://www.influxdata.com
        ### Config
        Add the following to your `jocasta-config.ini` file, making sure you update the values
        to match your InfluxDB server.
        ```
        [influxdb]
        host = 192.168.1.100
        port = 8086
        password = admin
        username = admin
        database = greenhouses
        ```
        
        ## Adafruit IO - https://io.adafruit.com
        Adafruit's beta IoT hosted application.
        
        ### Config
        ```
        [io_adafruit]
        username = username
        key = key
        feeds = temperature,light,humidity
        measurements = temperature,light,humidity
        ```
        
        ## File System
        Outputs` json` to a file on disk. This is handy for other applications to access the data.
        
        ### Config
        
        ```
        [file_system]
        file_name = /tmp/sensor_data.json
        ```
        
        ## MQTT
        TODO
        
        ## Kafka
        TODO
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
