https://github.com/streamingtime/barmband
Barmband is a wearable wristband designed to gamify social interactions.
https://github.com/streamingtime/barmband
cpp esp32 golang microcontroller platformio
Last synced: 4 months ago
JSON representation
Barmband is a wearable wristband designed to gamify social interactions.
- Host: GitHub
- URL: https://github.com/streamingtime/barmband
- Owner: StreamingTime
- Created: 2024-03-27T12:54:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-30T09:53:36.000Z (almost 2 years ago)
- Last Synced: 2025-01-30T13:29:02.769Z (12 months ago)
- Topics: cpp, esp32, golang, microcontroller, platformio
- Language: Go
- Homepage: https://www.barm.band
- Size: 10.4 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Barmband
Link: [barm.band](https://www.barm.band/)
Barmband is a wearable wristband designed to gamify social interactions. The concept is driven by the often daunting task of starting conversations in bars and pubs, where socialising is the lifeblood. Barmband offers an innovative solution - a fun, engaging tool that acts as an icebreaker in these social environments.
## Project structure
`documentation` contains the presentation and project report
`src` and `include` contain the Barmband firmware (PlatformIO/Arduino) [(instructions)](https://www.barm.band/docs/guides/flashing/)
`bandcommand` contains the management software (Go) [(instructions)](https://www.barm.band/docs/guides/management-software/)
`broker` contains a Docker compose setup to run a MQTT broker [(instructions)](https://www.barm.band/docs/guides/management-software/#mqtt-broker)
`ui_app` contains a Graphical user interface, visualizing the Barmbands (Processing)
`website` contains sources for https://www.barm.band/ (generated with Hugo)
## Useful Links
- Project description: [barm.band/project/](https://www.barm.band/project/)
- Installation guide: [barm.band/docs/guides/get-started/](https://www.barm.band/docs/guides/get-started/)
- Lookbook: [barm.band/lookbook/](https://www.barm.band/lookbook/)
[Graphical messaging and communication overview](https://www.tldraw.com/v/N9df8NquTPFi5-Oo25JAq?viewport=-170,48,1920,963&page=page:page)
## Prerequisites
### MQTT broker
In order to run the application, you need to have a MQTT broker running. You can use the `compose.yml` file in the `broker` directory to run a local MQTT broker. The broker is responsible for receiving messages from the clients and forwarding them to the appropriate subscribers. After running the broker, you have to configure the application to use the correct IP address and port of the broker. Adjust the `MQTT_HOST` and `MQTT_PORT` in `include/config.h` accordingly. The default port is `1883`. The IP address of the broker depends on your network configuration. If you are running the broker on the same machine as the application, you can use `localhost`.
Of course, you can also use a remote MQTT broker.
### Network configuration
The application uses the ESP32 WiFi module. You have to configure the WiFi module to connect to your WiFi network. Adjust the `WIFI_SSID` and `WIFI_PASSWORD` in `include/config.h` accordingly.
### Configuration
Configuration is done in `include/config.h`.
See `include/config_example.h`.
## Build and flash
```bash
pio run --target upload
```
### Serial monitor
```bash
pio device monitor
```
## Sources
- https://github.com/marvinroger/async-mqtt-client examples