Skip to content

Commit

Permalink
Renamed project.
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesSwift committed May 14, 2022
1 parent 6376b2e commit a2c778c
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
strategy:
matrix:
file:
- localbytes-plug-pm-v2.yaml
- localbytes-plug-pm.yaml
- minimal.yaml
steps:
- name: Checkout source code
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ jobs:
uses: esphome/workflows/.github/workflows/publish.yml@main
with:
# CHANGEME: Set the filenames of your config files here:
files: localbytes-plug-pm-v2.yaml,minimal.yaml
files: localbytes-plug-pm.yaml,minimal.yaml
# CHANGEME: Set the name of your project here:
name: Local Bytes Power Monitor Smart Plug V2
name: Local Bytes Power Monitor Smart Plug
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# About

This is an ESPHome firmware for the Localbytes Smart plug (V2), which is sold pre-loaded with tasmota. <a href="https://www.mylocalbytes.com/products/smart-plug-pm?variant=41600621510847">You can buy these smart plugs here</a>.
This is an ESPHome firmware for the Localbytes smart plug, which is sold pre-loaded with tasmota. This firmware supports the original 10A plug and the upgraded 13A plug. <a href="https://www.mylocalbytes.com/products/smart-plug-pm?variant=41600621510847">You can buy these smart plugs here</a>.

# Installation

To flash the ESPHome firmware over tasmota, first flash the `minimal` firmware using the tasmota web interface (as the full firmware is too big to fit in the free space left by tasmota). Then, connect to the hotspot and enter your wifi details.
To flash the ESPHome firmware over tasmota, first flash the <a hrf="https://github.com/JamesSwift/localbytes-plug-pm/releases/latest/download/minimal.bin">minimal</a> firmware using the tasmota web interface (as the full firmware is too big to fit in the free space left by tasmota). Then, connect to the hotspot and enter your wifi details.

At this point you can use the "dashboard import" feature of esphome to take ownership of the device. The next time you hit install/update via the dashboard, the full firmware will be uploaded to the plug.

Alternatively, if you don't want to import the plug to your ESPHome dashboard, connect to the hotpsot the device creates and use the web UI to flash the full `localbytes-plug-pm-v2` firmware from the latest release.
Alternatively, if you don't want to import the plug to your ESPHome dashboard, connect to the hotpsot the device creates and use the web UI to flash the <a href="https://github.com/JamesSwift/localbytes-plug-pm/releases/latest/download/loalbytes-plug-pm.bin">full firmware</a> from the latest release.

# Calibration

Once you have flashed the new firmware onto your smart plug and connected it to home assistant, you may wish to calibrate your plug to improve it's accuracy. To calibrate your plug, you need another "known-good" smart plug or a calibration device.

Plug your new smart plug into the known-good smart plug, then plug a kettle, toaster, or other high-power appliance into it. From home assistant, go to `Developer Tools` > `Services`. Use the services `calibrate_current`, `calibrate_power`, and `calibrate_voltage` to report the real readings as given from the "known-good" device. (Don't forget to turn on the kettle/toaster and leave it to stabalise it's power usage for a minute before starting to copy the readings).
Plug your new smart plug into the known-good smart plug, then plug a kettle, toaster, or other high-power appliance into it. From home assistant, go to `Developer Tools` > `Services`. Use the services `calibrate_current`, `calibrate_power`, and `calibrate_voltage` to report the real readings as given from the "known-good" device. (Don't forget to turn on the kettle/toaster and leave it to stabilize it's power usage for a moment before starting to copy the readings).
10 changes: 5 additions & 5 deletions localbytes-plug-pm-v2.yaml → localbytes-plug-pm.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# These substitutions allow the end user to override certain values
substitutions:
# Device Names
name: "localbytes-plug-v2"
friendly_name: "Localbytes Plug V2"
name: "localbytes-plug-pm"
friendly_name: "Localbytes Plug PM"

# Icon
main_icon: "power-socket-uk"
Expand All @@ -22,8 +22,8 @@ esphome:
# This will allow for (future) project identification,
# configuration and updates.
project:
name: localbytes.plug-pm-v2
version: "1.2.0"
name: localbytes.plug-pm
version: "1.3.0"

esp8266:
board: esp01_1m
Expand All @@ -35,7 +35,7 @@ ota:

# This should point to the public location of this yaml file.
dashboard_import:
package_import_url: github://JamesSwift/localbytes-plug-pm-v2/localbytes-plug-pm-v2.yaml@main
package_import_url: github://JamesSwift/localbytes-plug-pm/localbytes-plug-pm.yaml@main

wifi:
output_power: 14db
Expand Down
10 changes: 5 additions & 5 deletions minimal.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# These substitutions allow the end user to override certain values
substitutions:
# Device Names
name: "localbytes-plug-v2"
friendly_name: "Localbytes Plug V2"
name: "localbytes-plug-pm"
friendly_name: "Localbytes Plug PM"

esphome:
name: "${name}"
Expand All @@ -13,8 +13,8 @@ esphome:
# This will allow for (future) project identification,
# configuration and updates.
project:
name: localbytes.plug-pm-v2
version: "1.1"
name: localbytes.plug-pm
version: "1.3.0"

esp8266:
board: esp01_1m
Expand All @@ -25,7 +25,7 @@ ota:

# This should point to the public location of this yaml file.
dashboard_import:
package_import_url: github://JamesSwift/localbytes-plug-pm-v2/localbytes-plug-pm-v2.yaml@main
package_import_url: github://JamesSwift/localbytes-plug-pm/localbytes-plug-pm.yaml@main

wifi:
ap:
Expand Down
6 changes: 3 additions & 3 deletions static/_config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CHANGEME: Set these variable to your liking
title: Local Bytes Power Monitor Smart Plug V2
description: ESPHome firmware for localbytes power monitoring smart plug (v2)
theme: jekyll-theme-slate
title: Local Bytes Power Monitor Smart Plug
description: ESPHome firmware for localbytes power monitoring smart plug
theme: jekyll-theme-slate
15 changes: 0 additions & 15 deletions static/index.md

This file was deleted.

1 change: 1 addition & 0 deletions static/index.md

0 comments on commit a2c778c

Please sign in to comment.