Compare commits
2 Commits
60aaf30721
...
222ef53724
Author | SHA1 | Date | |
---|---|---|---|
222ef53724 | |||
3a841c5792 |
36
README.md
36
README.md
@ -1,27 +1,19 @@
|
|||||||
[![Built with po-util](https://rawgit.com/nrobinson2000/po-util/master/images/built-with-po-util.svg)](https://po-util.com)
|
# Renderbug: An embedded art engine
|
||||||
|
|
||||||
# This repository is a [po-util](https://po-util.com) project
|
Renderbug is a fast, efficient, and beautiful LED art engine for the ESP32 and
|
||||||
|
other chipsets that are able to talk to WS2812b (aka Neopixel) RGB LEDs.
|
||||||
|
|
||||||
Po makes it easy to locally develop firmware for Particle devices, and supports the Particle Photon, P1, Electron, Core, Raspberry Pi, and Redbear Duo.
|
## Features
|
||||||
|
|
||||||
Your project’s C++ files go in the `firmware/` directory, and the binary will appear in the `bin/` directory.
|
- Fun to use
|
||||||
|
- Fast as hell
|
||||||
|
- Microkernel architecture
|
||||||
|
- Functional API
|
||||||
|
- JSON Configuration
|
||||||
|
- Connectivity over Serial, Bluetooth, MQTT, and others
|
||||||
|
- Tasklets for rendering, input, and background services
|
||||||
|
- Surface mapping and projection algorithms (batteries included)
|
||||||
|
|
||||||
To compile code, run `po DEVICE_TYPE build`, substituting `DEVICE_TYPE` with `photon`, `P1`, `electron`, `core`, `pi`, or `duo`.
|
## Demonstration
|
||||||
|
|
||||||
To compile and flash code, run `po DEVICE_TYPE flash`. Code is compiled and then flashed to your device over USB.
|
[![blazing fast LEDs](https://img.youtube.com/vi/VbPOKY6_bkc/maxresdefault.jpg)]](https://www.youtube.com/shorts/VbPOKY6_bkc)
|
||||||
|
|
||||||
To clean the project, run `po DEVICE_TYPE clean`.
|
|
||||||
|
|
||||||
To flash a project over USB without rebuilding, run `po DEVICE_TYPE dfu`.
|
|
||||||
|
|
||||||
To upload a compiled project over the air run `po DEVICE ota DEVICE_NAME`, where `DEVICE_NAME` is the name of your device in the Particle cloud. **Note: You must be logged into particle-cli to use this feature. You can log into particle-cli with:**
|
|
||||||
|
|
||||||
```
|
|
||||||
particle login
|
|
||||||
```
|
|
||||||
|
|
||||||
For more help, run `man po`, or visit <https://docs.po-util.com/>
|
|
||||||
|
|
||||||
*By the way, po has tab completion. Try pressing [TAB] at any time to have arguments completed.*
|
|
||||||
|
|
||||||
Feel free to edit this README.md to make it more suitable for your project. **(I do ask that you please include the badge at the top though.)**
|
|
||||||
|
@ -214,6 +214,13 @@ MQTTTelemetry::loop()
|
|||||||
ConfigTaskMixin::loop();
|
ConfigTaskMixin::loop();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void
|
||||||
|
MQTTTelemetry::handleEvent(const InputEvent& evt)
|
||||||
|
{
|
||||||
|
OnlineTaskMixin::handle(evt);
|
||||||
|
ConfigTaskMixin::handleEvent(evt);
|
||||||
|
}
|
||||||
|
|
||||||
void
|
void
|
||||||
MQTTTelemetry::onOnline()
|
MQTTTelemetry::onOnline()
|
||||||
{
|
{
|
||||||
|
@ -45,6 +45,7 @@ class MQTTTelemetry : public BufferedInputSource, OnlineTaskMixin, ConfigTaskMix
|
|||||||
return &m_logPrinter;
|
return &m_logPrinter;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void handleEvent(const InputEvent& evt) override;
|
||||||
void handleEventOnline(const InputEvent& evt) override;
|
void handleEventOnline(const InputEvent& evt) override;
|
||||||
void handleConfigChange(const InputEvent& evt) override;
|
void handleConfigChange(const InputEvent& evt) override;
|
||||||
void loop() override;
|
void loop() override;
|
||||||
|
Loading…
Reference in New Issue
Block a user