Skip to content

Fix typos and other minor changes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fabaff wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix typos and other minor changes #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7fb14c
Fix typos and other minor changes
fabaff Oct 30, 2019
2fb95df
Merge branch 'master' into readme
fabaff Nov 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 19 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# myStrom WiFi Button

This repository contains opensource version of the firmware for myStrom WiFi Buttons. Both Plus and Simple buttons are supported.
This repository contains the Open source version of the firmware for myStrom WiFi Buttons. Both, the Wifi Button + and the Wifi Buttons are supported.

### How to build the FW from source code
### How to build the FW from source code?

- Install vagrant

Expand All @@ -13,31 +13,29 @@ This repository contains opensource version of the firmware for myStrom WiFi But
cd <REPO>
```

- Build project
- Build the project

```bash
vagrant up
vagrant ssh -c '/vagrant/build.sh <simple|plus>'
```

where simple is build for button light and plus is build for button plus
where `simple` is build for the WiFi Button and `plus` is build for the Wifi Button +.

After successfully build binary files can be found in `image` path
After a successful build, the binary files can be found in the `image` folder

- `<Simple|Plus>-FLASH-FW-$VERSION.bin` is a full flash image
- `<Simple|Plus>-FW-$VERSION-develop.bin` is a development build - print many logs on console
- `<Simple|Plus>-FW-$VERSION-release.bin` is a release version without printing logs on console

Once the binary FW is available it can be flashed into the device in one of these 2 ways:
Once the binary firmware is available it can be flashed into the device in one of these 2 ways:

1. OTA firmware upgrade function available in the myStrom Button standard firmware
2. By connecting UART to the programming port of the myStrom Button

### How to flash the firmware into the device using OTA upgrade?


#### How to flash the firmware into the device using OTA upgrade

To upgrade firmware currently flash in button you can use curl lie follow
To upgrade the firmware currently in the flash of the button, you can use `curl`, like shown below:

```bash
curl -F file=@<Simple|Plus>-FW-$VERSION-release.bin http://<button IP>/load
Expand All @@ -47,35 +45,33 @@ In order for this method to work the button must be in service mode or AP mode.

The off-the shelf myStrom buttons will not accept OTA upgrade to FW that is not released (signed) by myStrom. Therefore in the rom directory there are 2 binary firmwares Plus-FW-2.74.12-release.bin and Simple-FW-2.74.12-release.bin that are signed by myStrom which no loger check myStrom signature during the following OTA firmware upgrade.

The off-the shelf myStrom buttons will not accept OTA upgrade of firmware that is not released (signed) by myStrom. Therefore in the `rom` directory there are two binary firmwares `Plus-FW-2.74.12-release.bin` and `Simple-FW-2.74.12-release.bin` that are signed by myStrom which no longer check myStrom signature during the OTA firmware upgrade.

### How to flash the firmware into the device using UART?

#### How to flash the firmware into the device using UART

There are several tools available that allow flashing new firmware image to ESP8266. In these instructions it is assumed that esptool.py is used. Different tools may require using other options.
There are several tools available that allow flashing new firmware image to an ESP8266. In these instructions it is assumed that `esptool.py` is used. Different tools may require using other options.

In the myStrom Button Plus next to the batteries there is a 14 pin header socket that exposes ESP8266 pins requried for programming using esptool.py. The diagram below shows the assignemt of ESP8266 pins in that header socket.
<img src="PlusHeader.png" width="600">

Similarly, on the PCB of myStrom Button Simple there is a 18 pin header socket that exposes ESP8266 pins requried for programming using esptool.py. The diagram below shows the assignemt of ESP8266 pins in that header socket.
<img src="SimpleHeader.png" width="600">

To initial flash you can use esptool.py like follow
To initial flash you can use `esptool.py` like:

```bash
esptool.py --chip esp8266 --port <where usb serial adapter is connected> --baud <460800> write_flash --flash_freq keep --flash_mode keep --flash_size 2MB 0x0 <Simple|Plus>-FLASH-FW-$VERSION.bin
esptool.py --chip esp8266 --port <where USB serial adapter is connected> \
--baud <460800> write_flash --flash_freq keep --flash_mode keep \
--flash_size 2MB 0x0 <Simple|Plus>-FLASH-FW-$VERSION.bin
```

### Baudrates


#### Baudrates

Device outputs debug messages to the console port, which can be read by connecting UART. The following boudrates are used for outputting debug messages:
Device outputs debug messages to the console port, which can be read by connecting UART. The following baudrates are used for outputting debug messages:

- 460800 for develop firmware
- 74880 for release firmware

### HTTP REST API


#### HTTP REST API

The device offers HTTP API, description of that API is available at `http://<button_ip>/help`
The device offers a HTTP API, description of that API is available at `http://<button_ip>/help`.