diff --git a/api/binary_sensor/index.rst b/api/binary_sensor/index.rst index b3c359807..1f1ab852a 100644 --- a/api/binary_sensor/index.rst +++ b/api/binary_sensor/index.rst @@ -53,3 +53,69 @@ MQTTBinarySensorComponent :members: :protected-members: :undoc-members: + +Filters +******* + +.. doxygenclass:: binary_sensor::Filter + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::DelayedOnFilter + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::DelayedOffFilter + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::HeartbeatFilter + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::InvertFilter + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::LambdaFilter + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::UniqueFilter + :members: + :protected-members: + :undoc-members: + +Triggers +******** + +.. doxygenclass:: binary_sensor::PressTrigger + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::ReleaseTrigger + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::ClickTrigger + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::DoubleClickTrigger + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: binary_sensor::MultiClickTrigger + :members: + :protected-members: + :undoc-members: diff --git a/api/binary_sensor/remote_receiver.rst b/api/binary_sensor/remote_receiver.rst index 2a32edcb9..3f98cffaa 100644 --- a/api/binary_sensor/remote_receiver.rst +++ b/api/binary_sensor/remote_receiver.rst @@ -76,6 +76,11 @@ API Reference :protected-members: :undoc-members: +.. doxygenclass:: remote::SamsungReceiver + :members: + :protected-members: + :undoc-members: + .. doxygenclass:: remote::RCSwitchRawReceiver :members: :protected-members: diff --git a/api/core/deep-sleep.rst b/api/core/deep-sleep.rst index b57207034..b4e2ac2ae 100644 --- a/api/core/deep-sleep.rst +++ b/api/core/deep-sleep.rst @@ -15,3 +15,13 @@ DeepSleepComponent :members: :protected-members: :undoc-members: + +.. doxygenclass:: EnterDeepSleepAction + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: PreventDeepSleepAction + :members: + :protected-members: + :undoc-members: diff --git a/api/core/helpers.rst b/api/core/helpers.rst index f243e37e1..43a85c903 100644 --- a/api/core/helpers.rst +++ b/api/core/helpers.rst @@ -24,6 +24,11 @@ ESPPreferences :protected-members: :undoc-members: +.. doxygenclass:: ESPPreferenceObject + :members: + :protected-members: + :undoc-members: + .. doxygenvariable:: global_preferences esphal.h diff --git a/api/core/mqtt.rst b/api/core/mqtt.rst index bf3ead06b..892817df9 100644 --- a/api/core/mqtt.rst +++ b/api/core/mqtt.rst @@ -58,3 +58,28 @@ MQTTComponent :protected-members: :undoc-members: +Triggers +******** + +.. doxygenclass:: mqtt::MQTTMessageTrigger + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: mqtt::MQTTJsonMessageTrigger + :members: + :protected-members: + :undoc-members: + +Actions +******* + +.. doxygenclass:: mqtt::MQTTPublishAction + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: mqtt::MQTTPublishJsonAction + :members: + :protected-members: + :undoc-members: diff --git a/api/core/time.rst b/api/core/time.rst index ceed5226e..d7b55cbcc 100644 --- a/api/core/time.rst +++ b/api/core/time.rst @@ -6,7 +6,7 @@ API Reference .. cpp:namespace:: nullptr -.. doxygenclass:: time::RTCComponent +.. doxygenclass:: time::RealTimeClockComponent :members: :protected-members: :undoc-members: @@ -16,8 +16,12 @@ API Reference :protected-members: :undoc-members: - .. doxygenclass:: time::SNTPComponent :members: :protected-members: :undoc-members: + +.. doxygenclass:: time::CronTrigger + :members: + :protected-members: + :undoc-members: diff --git a/api/fan/index.rst b/api/fan/index.rst index 8ce55b0c1..9ac9eb4e6 100644 --- a/api/fan/index.rst +++ b/api/fan/index.rst @@ -63,3 +63,18 @@ MQTTFanComponent :members: :protected-members: :undoc-members: + +.. doxygenclass:: fan::ToggleAction + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: fan::TurnOnAction + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: fan::TurnOffAction + :members: + :protected-members: + :undoc-members: diff --git a/api/light/index.rst b/api/light/index.rst index 09a26600b..72f82369b 100644 --- a/api/light/index.rst +++ b/api/light/index.rst @@ -209,3 +209,18 @@ MQTTJSONLightComponent :members: :protected-members: :undoc-members: + +.. doxygenclass:: light::TurnOffAction + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: light::TurnOnAction + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: light::ToggleAction + :members: + :protected-members: + :undoc-members: diff --git a/api/misc/esp32_ble_tracker.rst b/api/misc/esp32_ble_tracker.rst index 37a227c15..c2d5afec1 100644 --- a/api/misc/esp32_ble_tracker.rst +++ b/api/misc/esp32_ble_tracker.rst @@ -36,12 +36,12 @@ API Reference :protected-members: :undoc-members: -.. doxygenclass:: XiaomiMiJiaDevice +.. doxygenclass:: XiaomiSensor :members: :protected-members: :undoc-members: -.. doxygenclass:: XiaomiMiFloraDevice +.. doxygenclass:: XiaomiDevice :members: :protected-members: :undoc-members: @@ -54,21 +54,7 @@ API Reference .. doxygenvariable:: global_esp32_ble_tracker .. doxygenvariable:: semaphore_scan_end -.. doxygentypedef:: XiaomiMiJiaTemperatureSensor -.. doxygentypedef:: XiaomiMiJiaHumiditySensor -.. doxygentypedef:: XiaomiMiJiaBatteryLevelSensor -.. doxygentypedef:: XiaomiMiFloraTemperatureSensor -.. doxygentypedef:: XiaomiMiFloraMoistureSensor -.. doxygentypedef:: XiaomiMiFloraIlluminanceSensor -.. doxygentypedef:: XiaomiMiFloraConductivitySensor -.. doxygentypedef:: XiaomiMiFloraBatteryLevelSensor - .. doxygenclass:: ESPBTUUID :members: :protected-members: :undoc-members: - -.. doxygenclass:: ESPBTDevice - :members: - :protected-members: - :undoc-members: diff --git a/api/output/index.rst b/api/output/index.rst index e11223748..beca659fa 100644 --- a/api/output/index.rst +++ b/api/output/index.rst @@ -28,3 +28,18 @@ FloatOutput :members: :protected-members: :undoc-members: + +.. doxygenclass:: output::TurnOnAction + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: output::TurnOffAction + :members: + :protected-members: + :undoc-members: + +.. doxygenclass:: output::SetLevelAction + :members: + :protected-members: + :undoc-members: diff --git a/api/sensor/bmp085.rst b/api/sensor/bmp085.rst index 0f50e19a8..7dcb5419f 100644 --- a/api/sensor/bmp085.rst +++ b/api/sensor/bmp085.rst @@ -2,12 +2,12 @@ BMP085 Pressure/Temperature Sensor ================================== The BMP085 component allows you get the temperature and pressure from your BMP085 -(`datasheet `_, -`adafruit `_), BMP180 -(`datasheet `_, -`adafruit `_) and BMP280 -(`datasheet `_, -`adafruit `_) sensors with esphomelib. To use these +(`datasheet BMP085 `_, +`adafruit BMP085 `_), BMP180 +(`datasheet BMP180 `_, +`adafruit BMP180 `_) and BMP280 +(`datasheet BMP280 `_, +`adafruit BMP280 `_) sensors with esphomelib. To use these i2c-based devices, first initialize the i2c bus using the pins you have for SDA and SCL and then create the sensors themselves as in below example. diff --git a/api/sensor/index.rst b/api/sensor/index.rst index 7cb8bfaed..f5ccba41e 100644 --- a/api/sensor/index.rst +++ b/api/sensor/index.rst @@ -26,8 +26,6 @@ Sensor :protected-members: :undoc-members: -.. doxygentypedef:: sensor::sensor_callback_t - .. doxygenclass:: sensor::PollingSensorComponent :members: :protected-members: diff --git a/api/sensor/pulse_counter.rst b/api/sensor/pulse_counter.rst index e4cf8cd71..c5ea696bd 100644 --- a/api/sensor/pulse_counter.rst +++ b/api/sensor/pulse_counter.rst @@ -1,10 +1,5 @@ -ESP32 Pulse Counter Sensor -========================== - -This component allows you to count pulses on a PIN using the internal -`pulse counter `_ peripheral of -the ESP32. By default, the values by this sensor are reported in "pulses/min". You can convert -that to your own unit like in below example. +Pulse Counter Sensor +==================== Example Usage ------------- diff --git a/api/sensor/total_daily_energy.rst b/api/sensor/total_daily_energy.rst new file mode 100644 index 000000000..049c51c18 --- /dev/null +++ b/api/sensor/total_daily_energy.rst @@ -0,0 +1,16 @@ +Total Daily Energy Sensor +========================= + +.. cpp:namespace:: nullptr + +See :cpp:func:`Application::make_total_daily_energy_sensor`. + +API Reference +------------- + +.. cpp:namespace:: nullptr + +.. doxygenclass:: sensor::TotalDailyEnergy + :members: + :protected-members: + :undoc-members: diff --git a/api/switch/index.rst b/api/switch/index.rst index c17897b8a..d2c68d3ff 100644 --- a/api/switch/index.rst +++ b/api/switch/index.rst @@ -21,10 +21,18 @@ Switch :protected-members: :undoc-members: -SimpleSwitch +OutputSwitch ************ -.. doxygenclass:: switch_::SimpleSwitch +.. doxygenclass:: switch_::OutputSwitch + :members: + :protected-members: + :undoc-members: + +GPIOSwitch +********** + +.. doxygenclass:: switch_::GPIOSwitch :members: :protected-members: :undoc-members: diff --git a/api/switch/remote_transmitter.rst b/api/switch/remote_transmitter.rst index 4c05b63fc..049d62121 100644 --- a/api/switch/remote_transmitter.rst +++ b/api/switch/remote_transmitter.rst @@ -46,6 +46,11 @@ API Reference :protected-members: :undoc-members: +.. doxygenclass:: remote::SamsungTransmitter + :members: + :protected-members: + :undoc-members: + .. doxygenclass:: remote::RawTransmitter :members: :protected-members: diff --git a/api/text_sensor/index.rst b/api/text_sensor/index.rst index 950980268..b6a853a47 100644 --- a/api/text_sensor/index.rst +++ b/api/text_sensor/index.rst @@ -26,7 +26,7 @@ TextSensor :protected-members: :undoc-members: -.. doxygenclass:: text_sensor::TextSensorValueTrigger +.. doxygenclass:: text_sensor::TextSensorStateTrigger :members: :protected-members: :undoc-members: diff --git a/esphomeyaml/changelog/index.rst b/esphomeyaml/changelog/index.rst index 63428d1b3..974708af6 100644 --- a/esphomeyaml/changelog/index.rst +++ b/esphomeyaml/changelog/index.rst @@ -12,6 +12,7 @@ Changelog - Version 1.9.0 PMSX003, components/sensor/pmsx003, pmsx003.svg esphomeflasher, guides/faq.html#i-can-t-get-flashing-over-usb-to-work, logo.svg + Total Daily Energy, components/sensor/total_daily_energy, sigma.svg New Components @@ -34,14 +35,19 @@ New Components - Added support for :doc:`A4988 Stepper Motors ` (:libpr:`239`, :yamlpr:`206`, :docspr:`68`) +- Added :doc:`total daily energy sensor ` to accumulate the total + power usage over one day (:libpr:`256`, :yamlpr:`220`) + New Features ------------ -- Compiling for ESP32s is now possible on RPis +- Compiling for ESP32s is now possible on RPis 🎉 -- :doc:`GPIO Switches ` now have a ``power_on_value`` option which will - initialize the state of the switch very early in the boot process - (:libpr:`207`, :docspr:`55`). +- esphomelib now has a new tool: `esphomeflasher `__ to simplify + flashing on Windows/MacOS machines **without having to install esphomeyaml**. So if esphomeyaml for some reason + can't find your USB port, you now can use the esphomeflasher app. See :ref:`esphomeflasher`. + +- ESP8266s now save the states of lights/switches/... internally and restore them on boot. (:libpr:`258`) - The :doc:`Over-the-Air Update ` process was quite buggy sometimes and the Arduino-library esphomelib used was doing some weird stuff. The OTA-process has now been completely re-written to be more stable @@ -71,9 +77,12 @@ New Features automations (:libpr:`232`, :yamlpr:`196`, :yamlpr:`198`, :docspr:`61`, :docspr:`63`) +- Added :ref:`binary_sensor-on_multi_click` trigger to distinguish between double, long, and single clicks. + (:libpr:`262`, :docspr:`77`, :yamlpr:`226`) + - Added an :ref:`pn532-on_tag` to :doc:`PN532 NFC Readers ` so that automations can directly use the NFC tag ID - (:libpr:`194`, :yamlpr:`189`, :doc:`57`) + (:libpr:`194`, :yamlpr:`189`, :docspr:`57`) - Added a ``hass-config`` command which generates a Home Assistant configuration for your esphomeyaml nodes. Useful if you're not using MQTT discovery (:yamlpr:`208`) @@ -93,6 +102,8 @@ New Features - Added a ``send_first_at`` option to sliding window moving average sensor filters (:libpr:`240`, :yamlpr:`207`, :docspr:`69`) +- You can now upload OTA firmware files with the :doc:`web server component ` + Breaking Changes ---------------- @@ -107,7 +118,7 @@ Breaking Changes For sensors and binary sensors, ``id(my_sensor).value`` has been deprecated and ``id(my_sensor).state`` should be used instead. Additionally, the syntax for toggling lights and switches through C++ has been changed. Please see - the :doc:`62` changeset for more information + the :docspr:`62` changeset for more information (:libpr:`231`, :docspr:`62`, :yamlpr:`197`) - In 1.8.2, you might have noticed that the WiFi performance has been greatly improved. This was due to the new default of @@ -123,109 +134,133 @@ Breaking Changes All changes ----------- -- esphomedocs: Clarify ESP32 BLE Tracker comment `#42 `__ -- esphomeyaml: Add a link to Home Assistant in README `#152 `__ by `@jonnyair `__ -- esphomelib: Add a link to Home Assistant in README.md `#184 `__ by `@jonnyair `__ -- esphomedocs: Fix time docs 12-hour clock strftime format `#43 `__ -- esphomelib: Fix ESP32 BLE Presence detection always on `#185 `__ -- esphomelib: Fix LCD display include `#186 `__ -- esphomelib: Fix template switch spamming output `#187 `__ -- esphomelib: Fix using HTU21D for SI7021 `#188 `__ -- esphomelib: Fix components sending invalid state on startup if integration not ready yet `#195 `__ -- esphomelib: Log esphomelib version and compilation time on boot `#189 `__ (new-feature) -- esphomeyaml: Log esphomelib version and compilation time on boot `#159 `__ (new-feature) -- esphomeyaml: Fix raw remote receiver `#158 `__ -- esphomelib: Add Code of Conduct (Contributor Covenant) `#196 `__ -- esphomelib: Create CONTRIBUTING.md `#197 `__ -- esphomelib: Create issue templates `#198 `__ -- esphomelib: Create pull request template `#199 `__ -- esphomeyaml: Create Pull Request Template `#172 `__ -- esphomeyaml: Create CONTRIBUTING.md `#169 `__ -- esphomeyaml: Add Code of Conduct (Contributor Covenant) `#168 `__ -- esphomeyaml: Create issue templates `#171 `__ -- esphomedocs: Add Code of Conduct (Contributor Covenant) `#44 `__ -- esphomedocs: Create Pull Request Template `#45 `__ -- esphomeyaml: Fix readme broken link `#174 `__ -- esphomelib: Fix pulse counter counting inverted on ESP8266 `#200 `__ -- esphomeyaml: Add use_build_flags removal notice `#173 `__ -- esphomedocs: Highlight update_interval gotchas `#46 `__ -- esphomedocs: Add Disqus and cleanup `#47 `__ (new-feature) -- esphomelib: Fix PN532 not logging discovered tags `#202 `__ -- esphomeyaml: Add Samsung IR protocol `#176 `__ by `@escoand `__ (new-feature) -- esphomedocs: add samsung ir protocol `#48 `__ by `@escoand `__ (new-feature) -- esphomelib: Bump FastLED to 3.2.0 `#203 `__ -- esphomeyaml: Fix Wifi power_save_mode option `#178 `__ -- esphomelib: Fix application sort order `#211 `__ -- esphomedocs: Improve pulse counter docs `#49 `__ -- esphomelib: Fix ESP32 BLE Controller Init `#213 `__ -- esphomelib: Fix Web Server Creating Infinite Print Loop `#214 `__ -- esphomelib: Add TOGGLE payload to more components `#212 `__ (new-feature) -- esphomelib: ESP8266 Pulse Counter Improve Timing `#205 `__ -- esphomelib: Add MQTT Subscribe Sensor `#193 `__ (new-feature) -- esphomedocs: Add MQTT Subscribe sensor `#50 `__ (new-feature) -- esphomeyaml: Add MQTT Subscribe sensor `#175 `__ (new-feature) -- esphomeyaml: MQTT different log level `#167 `__ (new-feature) -- esphomedocs: Add option to have different log level over MQTT `#51 `__ (new-feature) -- esphomeyaml: Add clean build files command and auto-clean on version change `#181 `__ (new-feature) -- esphomelib: Add power on value to switch `#207 `__ (new-feature) -- esphomelib: Rework OTA to be more stable `#204 `__ (breaking-change) (new-feature) -- esphomeyaml: Rework OTA to be more stable `#177 `__ (new-feature) -- esphomelib: Fix WiFi not working when GPIO 0 connected `#215 `__ -- esphomelib: Fix MiFlora illuminance reading `#220 `__ -- esphomelib: Remove invalid file headers `#219 `__ -- esphomeyaml: Fix config dump time output `#184 `__ -- esphomelib: GPIO Switch Rewrite `#217 `__ -- esphomedocs: Add power on value to GPIO Switch `#55 `__ (new-feature) -- esphomeyaml: GPIO Switch Power On Value v2 `#183 `__ -- esphomeyaml: Decentralize Automation Generator Code `#182 `__ -- esphomelib: Add PN532 On Tag Trigger `#226 `__ (new-feature) -- esphomelib: Add text sensors `#194 `__ (new-feature) -- esphomedocs: Add Text sensors `#52 `__ (new-feature) -- esphomelib: Fix PCF8574 assert. `#223 `__ by `@lobradov `__ -- esphomelib: Unify Xiaomi MiJia&MiFlora Implementations `#225 `__ -- esphomedocs: Unify xiaomi implementations `#56 `__ -- esphomeyaml: Unify Xiaomi implementations `#188 `__ -- esphomelib: Add CSE7766 for Sonoff Pow R2 `#227 `__ (new-feature) -- esphomedocs: Add CSE7766 for Sonoff Pow R2 `#59 `__ (new-feature) -- esphomedocs: Add PN532 On Tag Trigger `#57 `__ (new-feature) -- esphomeyaml: Add CSE776 for Sonoff Pow R2 `#190 `__ (new-feature) -- esphomeyaml: Add Text Sensors `#166 `__ (new-feature) -- esphomeyaml: Add PN532 On Tag Trigger `#189 `__ (new-feature) -- esphomelib: Add MQTT publish JSON action and subscribe JSON trigger `#230 `__ (new-feature) -- esphomeyaml: Add MQTT publish JSON action and subscribe JSON trigger `#193 `__ (new-feature) -- esphomedocs: Add MQTT publish JSON action and subscribe JSON trigger `#60 `__ (new-feature) -- esphomelib: Add PMSX003 Particulate Matter Sensor `#229 `__ (new-feature) -- esphomedocs: Add PMSX003 Particulate Matter Sensor `#58 `__ (new-feature) -- esphomelib: Add update component action and scripts `#232 `__ (new-feature) -- esphomedocs: Add update component action and scripts `#61 `__ (new-feature) -- esphomelib: Implement HASS device registry for MQTT components `#233 `__ (new-feature) -- esphomelib: Add FastLED color correction option `#234 `__ (new-feature) -- esphomedocs: Add FastLED color correction option `#64 `__ (new-feature) -- esphomeyaml: Add update component action and scripts `#196 `__ (new-feature) -- esphomeyaml: Add PMSX003 Particulate Matter Sensor `#192 `__ (new-feature) -- esphomeyaml: Add FastLED color correction option `#200 `__ (new-feature) -- esphomeyaml: Fix triggers being interpreted as a sequence of automations `#199 `__ -- esphomeyaml: Fix value range trigger :expressionless: `#201 `__ -- esphomelib: Make naming convention consistent `#231 `__ (breaking-change) -- esphomedocs: Make naming convention consistent `#62 `__ (breaking-change) -- esphomedocs: Fix some typos `#65 `__ -- esphomeyaml: Improve API naming convention consistency `#197 `__ (breaking-change) -- esphomeyaml: Fix some typos `#202 `__ -- esphomedocs: Add logger.log action `#63 `__ (new-feature) -- esphomeyaml: Add logger.log action `#198 `__ (new-feature) -- esphomedocs: Fix template sensor docs `#66 `__ -- esphomedocs: Fix text sensor outdated API docs `#70 `__ -- esphomedocs: Add Stepper Support `#68 `__ (new-feature) -- esphomelib: Add stepper motor support `#239 `__ (new-feature) -- esphomelib: Add send_first_at option to sliding window sensor filter `#240 `__ (new-feature) -- esphomedocs: Add send_first_at option to sliding window sensor filter `#69 `__ (new-feature) -- esphomelib: Fix display line drawing algorithm `#241 `__ -- esphomelib: Fix availability calculation `#242 `__ -- esphomeyaml: Add Stepper Motor Support `#206 `__ (new-feature) -- esphomeyaml: Add send_first_at option to sliding window sensor filter `#207 `__ (new-feature) -- esphomedocs: Switch example to Dehumidifier, minor grammar/puncuation `#67 `__ by `@rorpage `__ -- esphomeyaml: Auto-Decode stacktraces `#214 `__ (new-feature) -- esphomeyaml: Add generate home assistant config command `#208 `__ (new-feature) +- docs: Clarify ESP32 BLE Tracker comment :docspr:`42` +- yaml: Add a link to Home Assistant in README :yamlpr:`152` by :ghuser:`jonnyair` +- lib: Add a link to Home Assistant in README.md :libpr:`184` by :ghuser:`jonnyair` +- docs: Fix time docs 12-hour clock strftime format :docspr:`43` +- lib: Fix ESP32 BLE Presence detection always on :libpr:`185` +- lib: Fix LCD display include :libpr:`186` +- lib: Fix template switch spamming output :libpr:`187` +- lib: Fix using HTU21D for SI7021 :libpr:`188` +- lib: Fix components sending invalid state on startup if integration not ready yet :libpr:`195` +- lib: Log esphomelib version and compilation time on boot :libpr:`189` (new-feature) +- yaml: Log esphomelib version and compilation time on boot :yamlpr:`159` (new-feature) +- yaml: Fix raw remote receiver :yamlpr:`158` +- lib: Add Code of Conduct (Contributor Covenant) :libpr:`196` +- lib: Create CONTRIBUTING.md :libpr:`197` +- lib: Create issue templates :libpr:`198` +- lib: Create pull request template :libpr:`199` +- yaml: Create Pull Request Template :yamlpr:`172` +- yaml: Create CONTRIBUTING.md :yamlpr:`169` +- yaml: Add Code of Conduct (Contributor Covenant) :yamlpr:`168` +- yaml: Create issue templates :yamlpr:`171` +- docs: Add Code of Conduct (Contributor Covenant) :docspr:`44` +- docs: Create Pull Request Template :docspr:`45` +- yaml: Fix readme broken link :yamlpr:`174` +- lib: Fix pulse counter counting inverted on ESP8266 :libpr:`200` +- yaml: Add use_build_flags removal notice :yamlpr:`173` +- docs: Highlight update_interval gotchas :docspr:`46` +- docs: Add Disqus and cleanup :docspr:`47` (new-feature) +- lib: Fix PN532 not logging discovered tags :libpr:`202` +- yaml: Add Samsung IR protocol :yamlpr:`176` by :ghuser:`escoand` (new-feature) +- docs: add samsung ir protocol :docspr:`48` by :ghuser:`escoand` (new-feature) +- lib: Bump FastLED to 3.2.0 :libpr:`203` +- yaml: Fix Wifi power_save_mode option :yamlpr:`178` +- lib: Fix application sort order :libpr:`211` +- docs: Improve pulse counter docs :docspr:`49` +- lib: Fix ESP32 BLE Controller Init :libpr:`213` +- lib: Fix Web Server Creating Infinite Print Loop :libpr:`214` +- lib: Add TOGGLE payload to more components :libpr:`212` (new-feature) +- lib: ESP8266 Pulse Counter Improve Timing :libpr:`205` +- lib: Add MQTT Subscribe Sensor :libpr:`193` (new-feature) +- docs: Add MQTT Subscribe sensor :docspr:`50` (new-feature) +- yaml: Add MQTT Subscribe sensor :yamlpr:`175` (new-feature) +- yaml: MQTT different log level :yamlpr:`167` (new-feature) +- docs: Add option to have different log level over MQTT :docspr:`51` (new-feature) +- yaml: Add clean build files command and auto-clean on version change :yamlpr:`181` (new-feature) +- lib: Add power on value to switch :libpr:`207` (new-feature) +- lib: Rework OTA to be more stable :libpr:`204` (breaking-change) (new-feature) +- yaml: Rework OTA to be more stable :yamlpr:`177` (new-feature) +- lib: Fix WiFi not working when GPIO 0 connected :libpr:`215` +- lib: Fix MiFlora illuminance reading :libpr:`220` +- lib: Remove invalid file headers :libpr:`219` +- yaml: Fix config dump time output :yamlpr:`184` +- lib: GPIO Switch Rewrite :libpr:`217` +- docs: Add power on value to GPIO Switch :docspr:`55` (new-feature) +- yaml: Decentralize Automation Generator Code :yamlpr:`182` +- lib: Add PN532 On Tag Trigger :libpr:`226` (new-feature) +- lib: Add text sensors :libpr:`194` (new-feature) +- docs: Add Text sensors :docspr:`52` (new-feature) +- lib: Fix PCF8574 assert. :libpr:`223` by :ghuser:`lobradov` +- lib: Unify Xiaomi MiJia&MiFlora Implementations :libpr:`225` +- docs: Unify xiaomi implementations :docspr:`56` +- yaml: Unify Xiaomi implementations :yamlpr:`188` +- lib: Add CSE7766 for Sonoff Pow R2 :libpr:`227` (new-feature) +- docs: Add CSE7766 for Sonoff Pow R2 :docspr:`59` (new-feature) +- docs: Add PN532 On Tag Trigger :docspr:`57` (new-feature) +- yaml: Add CSE776 for Sonoff Pow R2 :yamlpr:`190` (new-feature) +- yaml: Add Text Sensors :yamlpr:`166` (new-feature) +- yaml: Add PN532 On Tag Trigger :yamlpr:`189` (new-feature) +- lib: Add MQTT publish JSON action and subscribe JSON trigger :libpr:`230` (new-feature) +- yaml: Add MQTT publish JSON action and subscribe JSON trigger :yamlpr:`193` (new-feature) +- docs: Add MQTT publish JSON action and subscribe JSON trigger :docspr:`60` (new-feature) +- lib: Add PMSX003 Particulate Matter Sensor :libpr:`229` (new-feature) +- docs: Add PMSX003 Particulate Matter Sensor :docspr:`58` (new-feature) +- lib: Add update component action and scripts :libpr:`232` (new-feature) +- docs: Add update component action and scripts :docspr:`61` (new-feature) +- lib: Implement HASS device registry for MQTT components :libpr:`233` (new-feature) +- lib: Add FastLED color correction option :libpr:`234` (new-feature) +- docs: Add FastLED color correction option :docspr:`64` (new-feature) +- yaml: Add update component action and scripts :yamlpr:`196` (new-feature) +- yaml: Add PMSX003 Particulate Matter Sensor :yamlpr:`192` (new-feature) +- yaml: Add FastLED color correction option :yamlpr:`200` (new-feature) +- yaml: Fix triggers being interpreted as a sequence of automations :yamlpr:`199` +- yaml: Fix value range trigger :expressionless: :yamlpr:`201` +- lib: Make naming convention consistent :libpr:`231` (breaking-change) +- docs: Make naming convention consistent :docspr:`62` (breaking-change) +- docs: Fix some typos :docspr:`65` +- yaml: Improve API naming convention consistency :yamlpr:`197` (breaking-change) +- yaml: Fix some typos :yamlpr:`202` +- docs: Add logger.log action :docspr:`63` (new-feature) +- yaml: Add logger.log action :yamlpr:`198` (new-feature) +- docs: Fix template sensor docs :docspr:`66` +- docs: Fix text sensor outdated API docs :docspr:`70` +- docs: Add Stepper Support :docspr:`68` (new-feature) +- lib: Add stepper motor support :libpr:`239` (new-feature) +- lib: Add send_first_at option to sliding window sensor filter :libpr:`240` (new-feature) +- docs: Add send_first_at option to sliding window sensor filter :docspr:`69` (new-feature) +- lib: Fix display line drawing algorithm :libpr:`241` +- lib: Fix availability calculation :libpr:`242` +- yaml: Add Stepper Motor Support :yamlpr:`206` (new-feature) +- yaml: Add send_first_at option to sliding window sensor filter :yamlpr:`207` (new-feature) +- docs: Switch example to Dehumidifier, minor grammar/puncuation :docspr:`67` by :ghuser:`rorpage` +- yaml: Auto-Decode stacktraces :yamlpr:`214` (new-feature) +- yaml: Add generate home assistant config command :yamlpr:`208` (new-feature) +- yaml: Update Gitlab Build Script :yamlpr:`215` +- lib: Fix status binary sensor always reporting false internally :libpr:`257` +- yaml: Fix HLW8012 Voltage Divider option not being added to source :yamlpr:`224` +- lib: Fix HLW8012 Initial Value Reporting :libpr:`254` +- lib: Clean up Time API :libpr:`253` +- yaml: Better typing to components :yamlpr:`225` +- lib: Support uploading OTA updates over web server :libpr:`255` (new-feature) +- lib: Save and Restore states from RTC memory :libpr:`258` (new-feature) +- docs: Revert add power_on_value to gpio switch :docspr:`78` +- lib: Improve default log levels and log sources :libpr:`264` +- lib: OTA Read back server acknowledgement :libpr:`263` +- lib: Add Multi Click Trigger to binary sensor :libpr:`262` (new-feature) +- docs: Add binary sensor on multi click trigger :docspr:`77` (new-feature) +- lib: ESP32 BLE Release Bluetooth Classic Memory :libpr:`261` +- yaml: Add restore state option to template switch :yamlpr:`222` +- docs: Advertise esphomeflasher :docspr:`76` (new-feature) +- docs: Replace table generator with custom RST directive :docspr:`75` +- yaml: Clean up time API :yamlpr:`221` +- yaml: Revert Add power on value to GPIO switch :yamlpr:`223` +- yaml: Add binary sensor multi click trigger :yamlpr:`226` (new-feature) +- lib: Add Total Daily Energy Sensor :libpr:`256` (new-feature) +- yaml: Add total daily energy sensor :yamlpr:`220` (new-feature) +- docs: Add total daily energy sensor :docspr:`79` + + Past Changelogs --------------- diff --git a/esphomeyaml/components/sensor/total_daily_energy.rst b/esphomeyaml/components/sensor/total_daily_energy.rst index eb79df094..351de1c96 100644 --- a/esphomeyaml/components/sensor/total_daily_energy.rst +++ b/esphomeyaml/components/sensor/total_daily_energy.rst @@ -2,7 +2,7 @@ Total Daily Energy Sensor ========================= The ``total_daily_energy`` sensor is a helper sensor that can use the energy value of -other sensors like the :doc:`HLW8012 `, :doc:`CSE7766 `, etc and integrate +other sensors like the :doc:`HLW8012 `, :doc:`CSE7766 `, etc and integrate it over time. So this component allows you to convert readings in ``W`` or ``kW`` to readings of the total diff --git a/esphomeyaml/guides/cli.rst b/esphomeyaml/guides/cli.rst index e9a887250..3b2e1db71 100644 --- a/esphomeyaml/guides/cli.rst +++ b/esphomeyaml/guides/cli.rst @@ -21,6 +21,8 @@ The ``esphomeyaml run`` command is the most common command for esphomey * Uploads the firmware (over OTA or USB) * Starts the log view +.. program:: esphomeyaml run + .. option:: --upload-port UPLOAD_PORT Manually specify the upload port/ip to use. For example ``/dev/cu.SLAB_USBtoUART``. @@ -52,6 +54,8 @@ The ``esphomeyaml run`` command is the most common command for esphomey ``config`` Command ------------------ +.. program:: esphomeyaml config + The ``esphomeyaml config`` validates the configuration and displays the validation result. .. option:: --topic TOPIC @@ -77,6 +81,8 @@ The ``esphomeyaml config`` validates the configuration and displays the ``compile`` Command ------------------- +.. program:: esphomeyaml compile + The ``esphomeyaml compile`` validates the configuration and compiles the firmware. .. option:: --only-generate @@ -86,6 +92,8 @@ The ``esphomeyaml compile`` validates the configuration and compiles th ``upload`` Command ------------------ +.. program:: esphomeyaml upload + The ``esphomeyaml upload`` validates the configuration and uploads the most recent firmware build. .. option:: --upload-port UPLOAD_PORT @@ -99,6 +107,8 @@ The ``esphomeyaml upload`` validates the configuration and uploads the ``clean-mqtt`` Command ---------------------- +.. program:: esphomeyaml clean-mqtt + The ``esphomeyaml clean-mqtt`` cleans retained MQTT discovery messages from the MQTT broker. See :ref:`mqtt-using_with_home_assistant`. @@ -122,39 +132,51 @@ See :ref:`mqtt-using_with_home_assistant`. ``wizard`` Command ------------------ +.. program:: esphomeyaml wizard + The ``esphomeyaml wizard`` command starts the esphomeyaml configuration creation wizard. ``mqtt-fingerprint`` Command ---------------------------- +.. program:: esphomeyaml mqtt-fingerprint + The ``esphomeyaml mqtt-fingerprint`` command shows the MQTT SSL fingerprints of the remote used for SSL MQTT connections. See :ref:`mqtt-ssl_fingerprints`. ``version`` Command ------------------- +.. program:: esphomeyaml version + The ``esphomeyaml version`` command shows the current esphomeyaml version and exits. ``clean`` Command ----------------- +.. program:: esphomeyaml clean + The ``esphomeyaml clean`` command cleans all build files and can help with some build issues. ``hass-config`` Command ----------------------- +.. program:: esphomeyaml hass-config + The ``esphomeyaml hass-config`` command shows an auto-generated Home Assistant configuration for the esphomeyaml node configuration file. This is useful if you're not using MQTT discovery. ``dashboard`` Command --------------------- +.. program:: esphomeyaml dashboard + The ``esphomeyaml dashboard`` command starts the esphomeyaml dashboard server for using esphomeyaml through a graphical user interface. .. option:: --port PORT - Manually set the HTTP port to open connections on (defaults to 6123) + Manually set the HTTP port to open connections on (defaults to 6052) .. option:: --password PASSWORD diff --git a/esphomeyaml/guides/faq.rst b/esphomeyaml/guides/faq.rst index 999ac3bd9..dd050d0a6 100644 --- a/esphomeyaml/guides/faq.rst +++ b/esphomeyaml/guides/faq.rst @@ -38,6 +38,8 @@ Tips for using esphomeyaml .. |include| replace:: ``!include`` .. _include: https://www.home-assistant.io/docs/configuration/splitting_configuration/ +.. _esphomeflasher: + I can't get flashing over USB to work. --------------------------------------