Skip to content

Tracks temperature and humidity readings and graphs the results in a web dashboard

License

Notifications You must be signed in to change notification settings

Buried-In-Code/Freyr

Repository files navigation

Freyr

Python Status

Rye Pre-Commit Ruff

Github - Version Github - License Github - Contributors

Tracks temperature and humidity readings and graphs the results in a web dashboard.
Collects readings using temperature sensors See PiicoDev Projects or Pico Projects for details.

Usage

via Github

  1. Make sure you have a supported version of Python installed: python --version
  2. Clone the repo: git clone https://github.com/Buried-In-Code/Freyr
  3. Install the project: pip install .
  4. Run using: Freyr

via Pipx

  1. Make sure you have Pipx installed: pipx --version
  2. Install the project pipx install git+https://github.com/Buried-In-Code/Freyr.git
  3. Run using: Freyr

via Docker-Compose

  1. Make sure you have Docker installed: docker --version
  2. Make sure you have Docker-Compose installed: docker-compose --version
  3. Create a docker-compose.yaml file, an example:
version: '3'

services:
  freyr:
    image: 'ghcr.io/buried-in-code/freyr:latest'
    container_name: 'Freyr'
    environment:
      TZ: 'Pacific/Auckland'
    ports:
      - '25710:25710'
    volumes:
      - './config:/app/config'
      - './data:/app/data'
  1. Run using: docker-compose up -d

Socials

Social - Fosstodon
Social - Matrix