Updated documentation
This commit is contained in:
erwin
102
code/firmware.yaml
Normal file
102
code/firmware.yaml
Normal file
@@ -0,0 +1,102 @@
|
||||
# ----------------------------------------------------------------
|
||||
# This file configures a D1 mini for displaying the next waste
|
||||
# container for collection.
|
||||
#
|
||||
# This is done by defining a strip of WS2811 LEDs as light and
|
||||
# setting the color through an automation in HomeAssistant.
|
||||
# The switch in the lid can be used as acknowledge that the
|
||||
# wastebin has been placed for collection.
|
||||
#
|
||||
# D1 wiring:
|
||||
# 5V power for LED strip
|
||||
# G ground for LED strio
|
||||
# D4 (GPIO2) data signal for LED strip
|
||||
# D2 (GPIO4) internal status LED and power for lid switch,
|
||||
# allowing for the disabling of the switch
|
||||
# D3 (GPIO0) lid switch input
|
||||
#
|
||||
# !secret variables are defined in secrets.yaml file
|
||||
# HomeAssistant API is disabled by default. You can enable this
|
||||
# if you prefer this over MQTT.
|
||||
#
|
||||
# ----------------------------------------------------------------
|
||||
|
||||
# ----------------------------------------------------------------
|
||||
# Module configuration
|
||||
# ----------------------------------------------------------------
|
||||
# Configure generic module settings
|
||||
esphome:
|
||||
#name: esp_5a098d
|
||||
name: wastebin_notifier
|
||||
platform: ESP8266
|
||||
board: d1_mini
|
||||
|
||||
# Configure Network settings
|
||||
wifi:
|
||||
ssid: !secret WIFI_SSID
|
||||
password: !secret WIFI_KEY
|
||||
domain: !secret WIFI_DOMAIN
|
||||
# Enable fallback hotspot in case wifi connection fails
|
||||
ap:
|
||||
ssid: !secret FALLBACK_AP_SSID
|
||||
password: !secret FALLBACK_AP_KEY
|
||||
|
||||
# Enable captive portal in case wifi connection fails
|
||||
captive_portal:
|
||||
|
||||
# Configure minimal logging
|
||||
logger:
|
||||
level: WARN
|
||||
|
||||
# Configure Over-the-Air updates
|
||||
ota:
|
||||
password: !secret OTA_KEY
|
||||
|
||||
## Configure Home Assistant API
|
||||
#api:
|
||||
|
||||
# Configure MQTT
|
||||
mqtt:
|
||||
broker: !secret MQTT_BROKER
|
||||
topic_prefix: "test/waste/notifier"
|
||||
|
||||
# ----------------------------------------------------------------
|
||||
# I/O configuration
|
||||
# ----------------------------------------------------------------
|
||||
|
||||
# Binary sensors ("status" is always available)
|
||||
binary_sensor:
|
||||
- platform: status
|
||||
name: wastebin_status
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO0
|
||||
inverted: true
|
||||
name: wastebin_lidswitch
|
||||
filters:
|
||||
# debounce delay
|
||||
- delayed_off: 10ms
|
||||
|
||||
# Sensors ("uptime" is always available)
|
||||
sensor:
|
||||
- platform: uptime
|
||||
name: wastebin_uptime
|
||||
update_interval: 3600s
|
||||
|
||||
# Switches ("restart" is always available)
|
||||
switch:
|
||||
- platform: restart
|
||||
name: wastebin_restart
|
||||
- platform: gpio
|
||||
pin: GPIO2
|
||||
name: wastebin_lidswitch_disable
|
||||
restore_mode: ALWAYS_OFF
|
||||
|
||||
# Lights
|
||||
light:
|
||||
- platform: fastled_clockless
|
||||
chipset: WS2812
|
||||
rgb_order: GRB
|
||||
pin: GPIO4
|
||||
num_leds: 5
|
||||
name: wastebin_lid
|
||||
@@ -1,39 +0,0 @@
|
||||
|
||||
This directory is intended for project header files.
|
||||
|
||||
A header file is a file containing C declarations and macro definitions
|
||||
to be shared between several project source files. You request the use of a
|
||||
header file in your project source file (C, C++, etc) located in `src` folder
|
||||
by including it, with the C preprocessing directive `#include'.
|
||||
|
||||
```src/main.c
|
||||
|
||||
#include "header.h"
|
||||
|
||||
int main (void)
|
||||
{
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
Including a header file produces the same results as copying the header file
|
||||
into each source file that needs it. Such copying would be time-consuming
|
||||
and error-prone. With a header file, the related declarations appear
|
||||
in only one place. If they need to be changed, they can be changed in one
|
||||
place, and programs that include the header file will automatically use the
|
||||
new version when next recompiled. The header file eliminates the labor of
|
||||
finding and changing all the copies as well as the risk that a failure to
|
||||
find one copy will result in inconsistencies within a program.
|
||||
|
||||
In C, the usual convention is to give header files names that end with `.h'.
|
||||
It is most portable to use only letters, digits, dashes, and underscores in
|
||||
header file names, and at most one dot.
|
||||
|
||||
Read more about using header files in official GCC documentation:
|
||||
|
||||
* Include Syntax
|
||||
* Include Operation
|
||||
* Once-Only Headers
|
||||
* Computed Includes
|
||||
|
||||
https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
|
||||
@@ -1,46 +0,0 @@
|
||||
|
||||
This directory is intended for project specific (private) libraries.
|
||||
PlatformIO will compile them to static libraries and link into executable file.
|
||||
|
||||
The source code of each library should be placed in a an own separate directory
|
||||
("lib/your_library_name/[here are source files]").
|
||||
|
||||
For example, see a structure of the following two libraries `Foo` and `Bar`:
|
||||
|
||||
|--lib
|
||||
| |
|
||||
| |--Bar
|
||||
| | |--docs
|
||||
| | |--examples
|
||||
| | |--src
|
||||
| | |- Bar.c
|
||||
| | |- Bar.h
|
||||
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
|
||||
| |
|
||||
| |--Foo
|
||||
| | |- Foo.c
|
||||
| | |- Foo.h
|
||||
| |
|
||||
| |- README --> THIS FILE
|
||||
|
|
||||
|- platformio.ini
|
||||
|--src
|
||||
|- main.c
|
||||
|
||||
and a contents of `src/main.c`:
|
||||
```
|
||||
#include <Foo.h>
|
||||
#include <Bar.h>
|
||||
|
||||
int main (void)
|
||||
{
|
||||
...
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
PlatformIO Library Dependency Finder will find automatically dependent
|
||||
libraries scanning project source files.
|
||||
|
||||
More information about PlatformIO Library Dependency Finder
|
||||
- https://docs.platformio.org/page/librarymanager/ldf.html
|
||||
@@ -1,14 +0,0 @@
|
||||
; PlatformIO Project Configuration File
|
||||
;
|
||||
; Build options: build flags, source filter
|
||||
; Upload options: custom upload port, speed and extra flags
|
||||
; Library options: dependencies, extra library storages
|
||||
; Advanced options: extra scripting
|
||||
;
|
||||
; Please visit documentation for the other options and examples
|
||||
; https://docs.platformio.org/page/projectconf.html
|
||||
|
||||
[env:d1_mini_pro]
|
||||
platform = espressif8266
|
||||
board = d1_mini_pro
|
||||
framework = arduino
|
||||
@@ -1,9 +0,0 @@
|
||||
#include <Arduino.h>
|
||||
|
||||
void setup() {
|
||||
// put your setup code here, to run once:
|
||||
}
|
||||
|
||||
void loop() {
|
||||
// put your main code here, to run repeatedly:
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
#ifndef MAIN_H
|
||||
#define MAIN_H
|
||||
|
||||
#define PIN_LEDSTRIP D2
|
||||
#define PIN_SWITCH_DISABLE D4
|
||||
#define PIN_SWITCH_ACTIVE D3
|
||||
|
||||
#define NUM_LEDS 5
|
||||
#define BRIGHTNESS 127
|
||||
#define LED_TYPE WS2811
|
||||
#define COLOR_ORDER GRB
|
||||
|
||||
void display(CRGB color, bool blink);
|
||||
|
||||
#endif
|
||||
@@ -1,11 +0,0 @@
|
||||
|
||||
This directory is intended for PlatformIO Unit Testing and project tests.
|
||||
|
||||
Unit Testing is a software testing method by which individual units of
|
||||
source code, sets of one or more MCU program modules together with associated
|
||||
control data, usage procedures, and operating procedures, are tested to
|
||||
determine whether they are fit for use. Unit testing finds problems early
|
||||
in the development cycle.
|
||||
|
||||
More information about PlatformIO Unit Testing:
|
||||
- https://docs.platformio.org/page/plus/unit-testing.html
|
||||
Reference in New Issue
Block a user