From 9d3b090a887b5963428a761b8d4cbffe7ac6350c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Orri=20S=C3=A6mundsson?= Date: Sun, 19 Jan 2020 22:03:23 +0100 Subject: [PATCH 1/5] Document salt device_tracker platform --- source/_integrations/salt.markdown | 44 ++++++++++++++++++++++++ source/images/supported_brands/salt.png | Bin 0 -> 1476 bytes 2 files changed, 44 insertions(+) create mode 100644 source/_integrations/salt.markdown create mode 100644 source/images/supported_brands/salt.png diff --git a/source/_integrations/salt.markdown b/source/_integrations/salt.markdown new file mode 100644 index 000000000000..d3c7be01d78b --- /dev/null +++ b/source/_integrations/salt.markdown @@ -0,0 +1,44 @@ +--- +title: Salt Fiber Box +description: Instructions on how to integrate Salt Fiber Box router into Home Assistant. +logo: salt.png +ha_category: + - Presence Detection +ha_iot_class: Local Polling +ha_codeowners: + - '@bjornorri' +ha_release: '0.105.0' +--- +The `salt` platform offers presence detection by looking at connected devices to a [Salt Fiber Box](https://fiber.salt.ch/en/fiber/equipment/fiber-box) router from [Salt](https://www.salt.ch) which is an internet provider in Switzerland. + +
+The router only allows one user session at a time. If you log into the router's web interface the platform will stop updating until you log out. +
+ +To use a Salt Fiber Box router in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +device_tracker: + - platform: salt + password: YOUR_PASSWORD +``` + +{% configuration %} +host: + description: The IP address of your router. + required: false + default: 192.168.1.1 + type: string +username: + description: The username used to log into the router's web interface. + required: false + default: admin + type: string +password: + description: The password used to log into the router's web interface. + required: true + type: string +{% endconfiguration %} + +See the [device tracker integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/images/supported_brands/salt.png b/source/images/supported_brands/salt.png new file mode 100644 index 0000000000000000000000000000000000000000..96728c59d687613ffa59976541e02c6b9e527e1c GIT binary patch literal 1476 zcmV;#1v~nQP)n3qvx8AWXv9aAPu{^~ex< za9R?9a)>m+jAIxF3WbmmOxKbJHzc0`0nfMX>>k|LF0Q+CF3-5n*8BD6eQ)Rf-1n~E zuANJptkxwaT5g{){ts%WkFgfp?0{%8-bt*z%iZo5>b>Y?J8ibw!|r#p%XQZJb=1!U zkJzD6B;4vG)z@4*g|N*-X1Ui-Z4}4s@ubNv)_P6xs!&vk+2{J1!$Mf5pVInUB}yFe zjGI(zjk+7GUjEr#bRd7D>=jKOkgm#4M8ZZ@TC20Xk#lyft*(~4J4I1L=A0))iK$w% zRXJyWMHnh)}y2ASmjzHnvAUY?9Ton^3Pr>64ol$L?P^RW`$=L{7&Sb z-PIl;X@cx7a#X0J!n1!ag2og%)U*W&^%{2adpD^6`bA4 zGVwuYe^+GKVXRZ7yV-A4X~WTR)W3zarRFu6Z6 zvqI8+nX^NKLZxRjO0>{gXDhABHX-TrWoCyfD?ghVqJ_5ju+p9q39mW5?CkHgh1pCK zEwo0#@vajIH&S-?lD09M>+KOO@@=I}cR)1RYdp%&Ue#7+)58+c0=sllS})^GHQGm- zadP~=?aYR2Z4k|N1Il-fIc@#d1`5961<@>vW!KL%>+QF@t6&0U7&@>DD(6{uG=;_S++A5>` zO=Q}s*6}{%2M&p%1uB1%_f6bS9JEju#X8z0+%2ni?)0CG*_%~SY_OflQ@-M}huAM9 zy`VeLSEKN(a$S^hzCTW}FE}Vl%%{S$&+)pD_O#mLAM3CSl&h1qB4rAok9S1EbtiH5 zV5D0hGK?vGz%xtv&azu19Mv0C`Gb%&=p@b_D&3j(i45!Enbg&o)l`vC2k4_wNV?)A z&c02$K_b&Zy4WR(?pD4_67!DwWb%1w#v`S#w&LuSLfT)|0Iu>&HDIJD!xi2aMf-hJ zxz2T1`riml7b$BgHbO{SnQQjaj2X*(N-q-}Gy`y@$n+kQGk=400}_9znqs#LX%FZC zt`=p!mXQizk&re{ve_cj5n;6|KsRrS49~MnB+QX6eKs!F-th)zK45s%N(V%m!=@Q- zl{E@rg-A0~vLT|3ZMr$$BO=2cyd{#%SCEb`IwG3PR-?3n29ar@Ux^H_IU97#ICr-w zD6K}l$gsu7ly-r4MVd`IaF4%>B=rVMcDkv>GvGPHr0ef3k>(wDp=ZXc>-0d4-etzr z>8+3$vsc6dV^bI8kn z?N;Y0UwdObX1jmcYPm^zDy^HzR@vf3fA*l!IxD71R@v_u;m7`Hy(i7_Sq0gh<`zqA eu+Bmw6#Fl#jLL@8*xmmC0000 Date: Mon, 20 Jan 2020 10:16:47 +0100 Subject: [PATCH 2/5] :pencil2: Tweaks --- source/_integrations/salt.markdown | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/source/_integrations/salt.markdown b/source/_integrations/salt.markdown index d3c7be01d78b..aab4f3cba47f 100644 --- a/source/_integrations/salt.markdown +++ b/source/_integrations/salt.markdown @@ -9,12 +9,15 @@ ha_codeowners: - '@bjornorri' ha_release: '0.105.0' --- -The `salt` platform offers presence detection by looking at connected devices to a [Salt Fiber Box](https://fiber.salt.ch/en/fiber/equipment/fiber-box) router from [Salt](https://www.salt.ch) which is an internet provider in Switzerland. + +The `salt` platform offers presence detection by looking at connected devices to a [Salt Fiber Box](https://fiber.salt.ch/en/fiber/equipment/fiber-box) router from [Salt](https://www.salt.ch), which is an internet provider in Switzerland.
-The router only allows one user session at a time. If you log into the router's web interface the platform will stop updating until you log out. +The router only allows one user session at a time. If you log into the router's web interface, the platform will stop updating until you log out.
+# Configuration + To use a Salt Fiber Box router in your installation, add the following to your `configuration.yaml` file: ```yaml From 80f4ca7a6f860d3d658dd1535c2282cda00a6c59 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 20 Jan 2020 10:17:03 +0100 Subject: [PATCH 3/5] Update salt.markdown --- source/_integrations/salt.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/salt.markdown b/source/_integrations/salt.markdown index aab4f3cba47f..87ca4b13690d 100644 --- a/source/_integrations/salt.markdown +++ b/source/_integrations/salt.markdown @@ -16,7 +16,7 @@ The `salt` platform offers presence detection by looking at connected devices to The router only allows one user session at a time. If you log into the router's web interface, the platform will stop updating until you log out. -# Configuration +## Configuration To use a Salt Fiber Box router in your installation, add the following to your `configuration.yaml` file: From 6cee0978e29a98c5585a696ed02a4e0c6e953487 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Orri=20S=C3=A6mundsson?= Date: Sun, 2 Feb 2020 14:24:54 +0100 Subject: [PATCH 4/5] Indicate all fields required --- source/_integrations/salt.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/_integrations/salt.markdown b/source/_integrations/salt.markdown index d3c7be01d78b..f0f54828e95b 100644 --- a/source/_integrations/salt.markdown +++ b/source/_integrations/salt.markdown @@ -21,19 +21,19 @@ To use a Salt Fiber Box router in your installation, add the following to your ` # Example configuration.yaml entry device_tracker: - platform: salt + host: 192.168.1.1 + username: admin password: YOUR_PASSWORD ``` {% configuration %} host: - description: The IP address of your router. - required: false - default: 192.168.1.1 + description: The IP address of your router, e.g. `192.168.1.1`. + required: true type: string username: - description: The username used to log into the router's web interface. - required: false - default: admin + description: The username used to log into the router's web interface, e.g. `admin`. + required: true type: string password: description: The password used to log into the router's web interface. From 4d43e77d849f7c79c6a31890b76fa911fdb970e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Orri=20S=C3=A6mundsson?= Date: Sun, 2 Feb 2020 17:51:01 +0100 Subject: [PATCH 5/5] Bump ha_release --- source/_integrations/salt.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/salt.markdown b/source/_integrations/salt.markdown index 400c6233b08d..232759569c25 100644 --- a/source/_integrations/salt.markdown +++ b/source/_integrations/salt.markdown @@ -7,7 +7,7 @@ ha_category: ha_iot_class: Local Polling ha_codeowners: - '@bjornorri' -ha_release: '0.105.0' +ha_release: '0.106.0' --- The `salt` platform offers presence detection by looking at connected devices to a [Salt Fiber Box](https://fiber.salt.ch/en/fiber/equipment/fiber-box) router from [Salt](https://www.salt.ch), which is an internet provider in Switzerland.