diff --git a/README.md b/README.md index 46a232b..d332a01 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # FBSmartHome -A small collection of usefull FritzBox SmartHome tools and scripts. Still in development and highly experimental. +A small collection of one usefull FritzBox SmartHome tool and one example script. Still in development and highly experimental. + +If you have any issues or questions regarding this tool and script just get in contact with me. ## fb-login-test.sh @@ -21,17 +23,27 @@ The config file for both script and client use the same syntax. ## fbsh-cli FritzBox SmartHome Console Client -### Compilation +I wrote the fbsh-cli tool to get a small easy low ressourced interface for the Fritzbox Smart Home devices. It should be able to get it running on most of the SoC devices which are out there. + +### Preparation -On debian you need the libxml2 and openssl devel pakages for compilation. If you have a debian based distribution you can install them with: +You need the libxml2 and openssl devel pakages for compilation. In addition you will need to download, compile and install the [libUDPTCPNetwork](https://steffen.gulpe.de/gitea/steffen/libUDPTCPNetwork) library which includes some helper functions i use. +If you have a debian based distribution you can install them with: apt install libxml2-dev libssl-dev + git clone https://steffen.gulpe.de/gitea/steffen/libUDPTCPNetwork.git + cd libUDPTCPNetwork + make + sudo make install + +## Compilation -Compile the source with make and run the binary. If needed manually copy the binary to a place of your choise. The Makefile does not support installation. +No comment here. Just download, compile and run the tool. + git clone https://steffen.gulpe.de/gitea/steffen/FBSmartHome.git + cd FBSmartHome make ./fbsh-cli - ### Configuration File @@ -54,6 +66,8 @@ Test the connection with `./fbsh-cli connect`. The successfull conntion will loo + saveconfig + connect + list ++ gethkr ++ listhkr + help @@ -61,3 +75,14 @@ Test the connection with `./fbsh-cli connect`. The successfull conntion will loo + HTTPS is yet not supported + sending commands to switches and lights + readin additional data from devices + +# Sample Output + + steffen@pc1 ~/Dokumente/Programmierung/FBSmartHome $ ./fbsh-cli listhkr + 01234 0001234 name:Heizung 1 temp:19.5 cur:19.5 set:21.0 + 01234 0001235 name:Heizung 2 temp:19.0 cur:19.0 set:19.0 + 01234 0001236 name:Heizung 3 temp:21.5 cur:21.5 set:22.0 + steffen@pc1 ~/Dokumente/Programmierung/FBSmartHome $ + +![Screenshot1](https://steffen.gulpe.de/progs/fbsh-cli_gethkr.png) +