https://github.com/graysonarts/rust-gpio-mqtt-bridge

A raspberry PI bridge between GPIO input pins and MQTT messages
https://github.com/graysonarts/rust-gpio-mqtt-bridge

Last synced: about 2 months ago
JSON representation

A raspberry PI bridge between GPIO input pins and MQTT messages

• Host: GitHub
• URL: https://github.com/graysonarts/rust-gpio-mqtt-bridge
• Owner: graysonarts
• License: mit
• Created: 2021-09-24T02:41:17.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-05T22:06:14.000Z (about 2 years ago)
• Last Synced: 2024-10-14T14:34:41.688Z (2 months ago)
• Language: Rust
• Size: 34.2 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/graysonarts/rust-gpio-mqtt-bridge/ci?style=for-the-badge) [![GitHub issues](https://img.shields.io/github/issues/graysonarts/rust-gpio-mqtt-bridge?style=for-the-badge)](https://github.com/graysonarts/rust-gpio-mqtt-bridge/issues) [![GitHub license](https://img.shields.io/github/license/graysonarts/rust-gpio-mqtt-bridge?style=for-the-badge)](https://github.com/graysonarts/rust-gpio-mqtt-bridge/blob/main/LICENSE) ![Requires.io](https://img.shields.io/requires/github/graysonarts/rust-gpio-mqtt-bridge?style=for-the-badge)

![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=for-the-badge)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=for-the-badge)](#contributors)

## Cross-Compile on Windows

Follow [these instructions](https://s2e-systems.github.io/Rust-RPi4-Windows-Cross-Compilation/) to setup rust to

cross compile from windows to raspberry pi.

## Running

1. set the environment variable `CTRL_HOST` to the hostname of your raspberry pi. If not set, we default to "raspberry". It can also be an IP address.

2. set the environment variable `CTRL_USER` to the username of your main user on your pi. If not set, we default to `pi`

3. run `run.bat` or `run.sh`

This runs the debug version, so it's not optimized. It will build, scp the file over, and then run it.

Make sure you can ssh into your pi without needing to type in a password by either using a ssh key agent

or having an unencrypted ssh key.

## Deployment

Same as running, but use the deploy script

## CONTRIBUTING

We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and [conventional comments](https://conventionalcomments.org/)

More details coming later.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Grayson Hay
💻 📖

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!