Metadata-Version: 2.1
Name: pi_weatherstation
Version: 0.0.5
Summary: Read the data from pimoroni BME680 and display on pimoroni SPI screen
Home-page: http://github.com/guilhermef/pi_weatherstation
Author: Guilherme Souza
Author-email: guilherme@souza.tech
License: MIT
Description: [![Build Status](https://www.travis-ci.com/guilhermef/pi_weatherstation.svg?branch=main)](https://www.travis-ci.com/guilhermef/pi_weatherstation)
        [![PyPI version](https://badge.fury.io/py/pi-weatherstation.svg)](https://badge.fury.io/py/pi-weatherstation)
        
        # pi_weatherstation
        Read the data from pimoroni BME680 and display on pimoroni SPI screen
        
        ![Sensors assembled](https://raw.githubusercontent.com/guilhermef/pi_weatherstation/main/examples/sensors.jpeg)
        
        ![Grafana dashboard](https://raw.githubusercontent.com/guilhermef/pi_weatherstation/main/examples/grafana_screenshot.png)
        
        ## Dependencies:
        * wkhtmltopdf(https://wkhtmltopdf.org/downloads.html)
        
        ## Install on RaspberryPI
        * Enable SPI and I2C
        * Install the dependencies
        ```
        sudo apt-get install python3-venv python3-dev libatlas-base-dev wkhtmltopdf libopenjp2-7
        ```
        * Create the folder to store the virtualenv
        ```
        mkdir pi_weatherstation
        
        cd pi_weatherstation
        ```
        * Create the virtualenv and activate it
        ```
        python3 -m venv .env
        
        source .env/bin/activate
        ```
        * Install the via pip with the sensors dependencies
        ```
        pip install pi_weatherstation\[st7789,bme680\]
        ```
        
        * Run
        ```
        pi_weatherstation -l debug
        ```
        
        ## Config file
        You can copy the example config file from https://github.com/guilhermef/pi_weatherstation/blob/main/examples/config.ini
        
        The field `metrics_location_label` will be added as a location label on prometheus.
        
        Then you can run `pi_weatherstation -c <path to config.ini>`
        
        ## Long term data storage
        This will also start a prometheus metric server that you can use to scrape.
        You can configure a label name location if you have multiple instances.
        
        [Install Prometheus on RaspberryPI](https://linuxhit.com/prometheus-node-exporter-on-raspberry-pi-how-to-install/)
        
        [Create a free account on Grafana Cloud](https://grafana.com/products/cloud/)
        
        Copy the existing prometheus.yml file to scrape the local pi_weatherstation,
        and add your remote_write auth on it.
        https://github.com/guilhermef/pi_weatherstation/blob/main/examples/prometheus.yml
        
        Import the example dashboard on your new Grafana: https://github.com/guilhermef/pi_weatherstation/blob/main/examples/grafana_dashboard.json
        
        ## Running as a service
        If you want, you can use the systemd service unit file as an example
        https://github.com/guilhermef/pi_weatherstation/blob/main/examples/pi_weatherstation.service
        to `/etc/systemd/system/pi_weatherstation.service`
        
        then, run:
        ```
        sudo systemctl daemon-reload
        sudo systemctl enable pi_weatherstation.service
        sudo systemctl start pi_weatherstation.service
        ```
        
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Framework :: AsyncIO
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
Provides-Extra: st7789
Provides-Extra: bme680
