https://github.com/buried-in-code/freyr

Tracks temperature and humidity readings and graphs the results in a web dashboard
https://github.com/buried-in-code/freyr

dht22 fastapi hatchling micropython pi-pico-w python-3

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/buried-in-code/freyr
• Owner: Buried-In-Code
• License: mit
• Created: 2023-07-06T08:59:53.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-27T20:20:56.000Z (about 1 year ago)
• Last Synced: 2024-05-28T06:07:04.204Z (about 1 year ago)
• Topics: dht22, fastapi, hatchling, micropython, pi-pico-w, python-3
• Language: Python
• Homepage:
• Size: 188 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Freyr

![Python](https://img.shields.io/badge/Python-3.11-green?style=flat-square)

![Status](https://img.shields.io/badge/Status-Beta-yellowgreen?style=flat-square)

[![Rye](https://img.shields.io/badge/Packaging-Rye-informational?style=flat-square)](https://github.com/astral-sh/rye)

[![Pre-Commit](https://img.shields.io/badge/Pre--Commit-Enabled-informational?style=flat-square&logo=pre-commit)](https://github.com/pre-commit/pre-commit)

[![Ruff](https://img.shields.io/badge/Linter-Ruff-informational?style=flat-square)](https://github.com/astral-sh/ruff)

[![Github - Version](https://img.shields.io/github/v/tag/Buried-In-Code/Freyr?logo=Github&label=Version&style=flat-square)](https://github.com/Buried-In-Code/Freyr/tags)

[![Github - License](https://img.shields.io/github/license/Buried-In-Code/Freyr?logo=Github&label=License&style=flat-square)](https://opensource.org/licenses/MIT)

[![Github - Contributors](https://img.shields.io/github/contributors/Buried-In-Code/Freyr?logo=Github&label=Contributors&style=flat-square)](https://github.com/Buried-In-Code/Freyr/graphs/contributors)

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

Collects readings using temperature sensors _See [PiicoDev Projects](https://github.com/Buried-In-Code/PiicoDev-Projects) or [Pico Projects](https://github.com/Buried-In-Code/Pico-Projects) for details._

## Usage

### via Github

1. Make sure you have a supported version of [Python](https://www.python.org/) 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](https://github.com/pypa/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](https://www.docker.com/) installed: `docker --version`

2. Make sure you have [Docker-Compose](https://github.com/docker/compose) installed: `docker-compose --version`

3. Create a `docker-compose.yaml` file, _an example:_

```yaml

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'

```

4. Run using: `docker-compose up -d`

## Socials

[![Social - Fosstodon](https://img.shields.io/badge/%40BuriedInCode-teal?label=Fosstodon&logo=mastodon&style=for-the-badge)](https://fosstodon.org/@BuriedInCode)\

[![Social - Matrix](https://img.shields.io/badge/%23The--Dev--Environment-teal?label=Matrix&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)