Remove myStrom button documentation references (#30004)

This commit is contained in:
Franck Nijhof 2023-11-26 10:13:13 +01:00 committed by GitHub
parent 0663ab17a8
commit b9c9018ade
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -23,7 +23,6 @@ There is currently support for the following device types within Home Assistant:
- [Lights and switches](#lights-and-switches) - [Lights and switches](#lights-and-switches)
- [Binary sensor](#binary-sensor) - [Binary sensor](#binary-sensor)
- [Setup of myStrom buttons](#setup-of-mystrom-buttons)
## Lights and switches ## Lights and switches
@ -93,54 +92,3 @@ binary_sensor:
<div class='note'> <div class='note'>
The firmware version 2.56 doesn't support TLS/SSL. This means that you are only able to use the WiFi Buttons if you are using plain-text communication between Home Assistant and the clients/entities. The firmware version 2.56 doesn't support TLS/SSL. This means that you are only able to use the WiFi Buttons if you are using plain-text communication between Home Assistant and the clients/entities.
</div> </div>
### Setup of myStrom Buttons
You need to configure every button to make it work with Home Assistant. First connect the Wifi Buttons to your wireless network. Once a button is connected you have three minutes to set the actions for the push patterns if the button is not charging. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about the implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern (see above).
The endpoint that is receiving the data is `http://[IP address Home Assistant]:8123/api/mystrom`. If you have set an [`api_password`](/integrations/http/) then this needs to be included in the URL.
With `api_password:`
```bash
curl -d "[action]=get://[IP address Home Assistant]:8123/api/mystrom?api_password%3D[api_password]%26[action]%3D[ID of the button]" \
http://[IP address of the button]/api/v1/device/[MAC address of the button]
```
Without `api_password`:
```bash
$ curl -d "[action]=get://[IP address Home Assistant]:8123/api/mystrom?[action]%3D[ID of the button]" \
http://[IP address of the button]/api/v1/device/[MAC address of the button]
{
"[MAC address of the button]": {
"type": "button",
"battery": true,
"reachable": true,
"meshroot": false,
"charge": true,
"voltage": 4.292,
"fw_version": "2.56",
"single": "get://[IP address Home Assistant]:8123/api/mystrom?single=[id of the button]",
"double": "",
"long": "",
"touch": ""
}
}
```
A complete command to set the URL for a double click could look like the example below:
```bash
curl -d "double=get://192.168.1.3:8123/api/mystrom?double%3DButton1" http://192.168.1.12/api/v1/device/4D5F5D5CD553
```
With an `api_password`:
```bash
curl -d "double=get://192.168.1.3:8123/api/mystrom?api_password%3Dapi_password%26double%3DButton1" http://192.168.1.12/api/v1/device/4D5F5D5CD553
```
The command-line tool [`mystrom`](https://github.com/fabaff/python-mystrom) is a helper to configure myStrom buttons.
If you have set [`login_attempts_threshold`](/integrations/http/) and forget to include the `api_password` for an action and that action is triggered then after the threshold is reached will the button no longer work because it is banned. See [IP filtering and banning](/integrations/http/#ip-filtering-and-banning) about how to revert the banning.