https://github.com/stephenyeargin/trmnl-adafruit-io

👩‍🏭 Adafruit IO for TRMNL
https://github.com/stephenyeargin/trmnl-adafruit-io

adafruit adafruit-io hacktoberfest trmnl trmnl-plugin

Last synced: 4 months ago
JSON representation

👩‍🏭 Adafruit IO for TRMNL

• Host: GitHub
• URL: https://github.com/stephenyeargin/trmnl-adafruit-io
• Owner: stephenyeargin
• License: mit
• Created: 2025-07-05T22:14:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-10-20T03:22:56.000Z (9 months ago)
• Last Synced: 2025-10-20T07:23:15.471Z (9 months ago)
• Topics: adafruit, adafruit-io, hacktoberfest, trmnl, trmnl-plugin
• Language: Liquid
• Homepage: https://usetrmnl.com/recipes/112643
• Size: 234 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-trmnl - Adafruit IO - Adafruit IO by stephenyeargin (🔌 Plugins - General)

README

          
# Adafruit IO for TRMNL

[![Build and Deploy](https://github.com/stephenyeargin/trmnl-adafruit-io/actions/workflows/build.yml/badge.svg)](https://github.com/stephenyeargin/trmnl-adafruit-io/actions/workflows/build.yml)

![promo](assets/promo.png)

## Screenshots

![screenshot](assets/screenshot.png)

## Development

### Creating synthetic data

- Create an Adafruit IO project with the slug `demo-iot-data`

- Set the environment variables for `IO_USERNAME` and `IO_KEY`

- Run `./bin/generate_synthetic_data.sh` to generate a data point every 10 seconds

### Releasing

This project uses automated releases based on the `VERSION` file. To create a new release:

1. Update the version using the bump script:

   ```bash

   ./bin/bump-version [major|minor|patch]

   ```

2. Commit and push the version change:

   ```bash

   git add VERSION

   git commit -m "Bump version to X.Y.Z"

   git push origin main

   ```

3. The GitHub Action will automatically:

   - Create a git tag for the new version

   - Generate release notes from commits

   - Create a GitHub release

   - Deploy to TRMNL using `trmnlp push`

### Manual Development

For local development and testing:

```bash

# Run development server

./bin/dev

# Push to TRMNL (requires API key configuration)

trmnlp push

```