vmario/fabaccess-docs
1
0
Fork 0
mirror of https://gitlab.com/fabinfra/fabaccess/docs.git synced 2024-12-22 12:03:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into 'main'

Browse Source 
moved the tasmota documentation

See merge request fabinfra/fabaccess/docs!8
This commit is contained in:
Falko Richter 2024-07-12 10:30:04 +00:00
commit 3fc1b96431
2 changed files with 109 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/configuration/bffh_config.md
View File

@ -178,6 +178,10 @@ Contains list of actors
Actors are defined by a module and one or more paramters
Currenty supported actors:
#### `Actors` that can be added manually
https://gitlab.com/fabinfra/fabaccess/actors contains a list of actors.
#### `Shelly Actor`
This actor connects BFFH over an MQTT-Server to an shelly device.

109
source/usage/setup_steps.md
View File

@ -41,13 +41,13 @@ You will be asked to sign in. For Version 0.2 only the Option "LOGIN WITH PASSWO
You will find an overview of the installed machines including the option "SCAN QR-CODE".
Next step is setting up you machines so they can be switched on an off.
**Step 4 Prepare your Shellies**
## Step 4 Prepare your Shellies
as long as your Shelly has not been given the credentials for a WLAN, it will create an access point (AP) for configuration when connected to the supply voltage. This AP will appear in your list of WLAN.
Connect to this Shelly-AP and connect to `192.168.33.1` in your browser. A configuration page should appear.
If your Shelly is already connected to your WLAN, you must find the assigned IP-Adress (e.g. by looking into your router). Enter this IP Adress in your browser and you will get the configuration page.
**Shelly MQTT Client setup**
### Shelly MQTT Client setup
goto "Internet & Security" -> "Advanced - Developer Settings"
enable "MQTT"
@ -60,14 +60,115 @@ note this ID for later
**- save**
**- re-check the settings!**
**Shelly WLAN Client setup**
### Shelly WLAN Client setup
goto "Internet & Security" -> "WIFI MODE - CLIENT"
Set WLAN Credentials
**Adding a Shelly to your server**
## FabAccess Tasmota Actor konfigurieren
### Actor verfügbar machen
```
git clone https://gitlab.com/fabinfra/fabaccess/actors/tasmota.git adapters/tasmota
chmod +x adapters/tasmota/main.py
```
### Actor in bffh.dhall konfigurieren
```
actors =
{
tasmota_F0A4FB =
{
module = "Process",
params =
{
cmd = "/usr/local/lib/bffh/adapters/tasmota/main.py",
args = "--host mqtt --tasmota F0A4FB"
}
}
},
```
### Adding a Shelly to your server
To understand the underlaying concept of actors and machines, please see the "configuration part" of the documentation. Four our example we will assume we have one actor (shelly) per machine.
## Nous A1T / Tasmota konfigurieren
<https://tasmota.github.io/docs/Commands/>
### PowerOnState auf 0 setzen, um eine Art Wiederanlaufschutz zu haben
> PowerOnState Control power state when the device is powered up. More information
> 0 / OFF = keep power(s) OFF after power up
> 1 / ON = turn power(s) ON after power up
> 2 / TOGGLE = toggle power(s) from last saved state
> 3 = switch power(s) to their last saved state (default)
> 4 = turn power(s) ON and disable further power control
> 5 = after a PulseTime period turn power(s) ON (acts as inverted PulseTime mode)
### Ggf. FriendlyName auf etwas lesbares ändern
!! Fuktioniert das noch mit dem Tasmota Actor? !!
> FriendlyName<x> 1 = Reset friendly name to firmware default
> <value> = set friendly name (32 char limit)
### Tasmota aktualiseren
> Upgrade 1 = download firmware from OtaUrl and restart
> 2 = (ESP32 only) download safeboot firmware based on OtaUrl and restart into safeboot
> <value> = download firmware from OtaUrl if <value> is higher than device version
### Werbserver ausschalten und konfiguration nur über MQTT machen
!! Ist dann noch ein separates Netzwerk erforderlich? !!
> Webserver 0 = stop web server
> 1 = start web server in user mode
> 2 = start web server in admin mode
### Farbschema anpassen
<https://tasmota.github.io/docs/Commands/#webcolor>
```
WebColor {"WebColor":["#727272","#fafafa","#fafafa","#3f484e","#fafafa","#25d0aa","#3f484e","#ca291d","#1dca29","#000000","#25d0aa","#1a9378","#ca291d","#8a1b14","#25d0aa","#1a9378","#ffffff","#25d0aa","#3b474d"]}
```
### WiFi einrichten
> SSId<x> <x> = 1..2
> <value> = set AP<x> Wi-Fi SSID and restart
> 1 = reset AP<x> Wi-Fi SSID to firmware default (STA_SSID1 or STA_SSID2) and restart
> SSID are limited to 32 characters. Do not use special characters or white spaces in the SSID
> Password<x> <x> = 1..2
> <value> = set AP<x> Wi-Fi password and restart
> 1 = reset AP<x> Wi-Fi password to firmware default (STA_PASS1 or STA_PASS2) and restart
> Passwords are limited to 64 characters. Do not use special characters or white spaces in the password.
> Note that Password and Password1 are equivalent commands.
### MQTT einrichten
> MqttHost 0 = clear MQTT host field and allow mDNS to find MQTT host
> 1 = reset MQTT host to firmware default (MQTT_HOST) and restart
> <value> = set MQTT host and restart (do NOT use .local)
> MqttUser 0 = clear MQTT user name
> 1 = reset MQTT user name to firmware default (MQTT_USER) and restart
> <value> = set MQTT user name and restart
> MqttPassword 0 = clear MQTT password
> 1 = reset MQTT password to firmware default (MQTT_PASS) and restart
> <value> = set MQTT password and restart (min 5 chars)
> MqttPort 1 = reset MQTT port to firmware default (MQTT_PORT) and restart
> <value> = set MQTT port between 2 and 32766 and restart
**Tip**
Prior to modifying the configuration files the proper working of the MQTT broker should be tested. To test the broker it is the best to use a second (linux) computer with a different IP adress. To test if the broker allows access from an external IP address open a MQTT subscriber on the second computer by typing <br>
`mosquitto_sub -h 192.168.1.15 -t /test/topic` (change the IP adress to the adress of your server).<br>