From afaac7b97bd52a716119d7eee9cab9a331846177 Mon Sep 17 00:00:00 2001 From: Tom Duijf Date: Thu, 8 Oct 2015 13:57:28 +0200 Subject: [PATCH] device_tracker: Generic SNMP --- source/components/device_tracker.markdown | 3 +- .../components/device_tracker.snmp.markdown | 37 ++++++++++++++++++ source/components/index.markdown | 5 +++ .../images/supported_brands/network-snmp.png | Bin 0 -> 2140 bytes 4 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 source/components/device_tracker.snmp.markdown create mode 100644 source/images/supported_brands/network-snmp.png diff --git a/source/components/device_tracker.markdown b/source/components/device_tracker.markdown index 78004ea3307..544312e23cc 100644 --- a/source/components/device_tracker.markdown +++ b/source/components/device_tracker.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Home Assistant can get information from your wireless router to track which devices are connected. There are three different types of supported wireless routers: +Home Assistant can get information from your wireless router to track which devices are connected. There are several brands of supported wireless routers: - [Actiontec](/components/device_tracker.actiontec.html) - [Aruba](/components/device_tracker.aruba.html) @@ -20,6 +20,7 @@ Home Assistant can get information from your wireless router to track which devi - [Thomson](/components/device_tracker.thomson.html) - [tomato](/components/device_tracker.tomato.html) - [TP-Link](/components/device_tracker.tplink.html) +- [Generic SNMP](/components/device_tracker.snmp.html) Alternative trackers: diff --git a/source/components/device_tracker.snmp.markdown b/source/components/device_tracker.snmp.markdown new file mode 100644 index 00000000000..0bd6c7a345e --- /dev/null +++ b/source/components/device_tracker.snmp.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Generic SNMP support" +description: "Instructions how to integrate SNMP into Home Assistant." +date: 2015-10-08 12:00 +sidebar: false +comments: false +sharing: true +footer: true +--- + + +Most wifi-accesspoints (WAP) and wifi-routers (WRT) support the Simple Network Management Protocol (SNMP). +This is a standardized method for monitoring/manageing network connected devices. SNMP uses a tree-like +hierarchy where each node is an object. Many of these objects contain (live) lists of insances and metrics, +like network interfaces, disks, and wifi registrations. + +This component uses python-pysnmp. + +```yaml +# Example configuration.yaml entry +device_tracker: + platform: snmp + hosts: 192.168.1.1 + community: public + baseoid: 1.3.6.1.4.1.14988.1.1.1.2.1.1 +``` + +`community` is the SNMP community which is configured in the WAP/WRT. Most devices have a default +community set to to `public` with read-only permission (which is sufficient). This parameter is mandatory + +`baseoid` is the OID prefix where wireless client registrations can be found, usually vendor specific. +It's advised to use the numerical notation. To find this base OID, check vendor documentation or check +the MIB file for your device. + +See the [device tracker component page](/components/device_tracker.html) for instructions how to +configure the people to be tracked. diff --git a/source/components/index.markdown b/source/components/index.markdown index e4aadcaa32b..e9c84f08693 100644 --- a/source/components/index.markdown +++ b/source/components/index.markdown @@ -216,6 +216,11 @@ Entities are things that you want to observe within Home Assistant. Support for NMap network scanning + + + SNMP capable devices + + diff --git a/source/images/supported_brands/network-snmp.png b/source/images/supported_brands/network-snmp.png new file mode 100644 index 0000000000000000000000000000000000000000..d48e8dec4f43751e2396af543453b8d68ce0f754 GIT binary patch literal 2140 zcmV-i2&4CjP)jDk{#B%(oJOnebFNuwAiq^*k0)Uj!&cG|?It<6l0F^_4? zqp6+Dq%e`0V2r7)nn{h2L8ClO4Jt}~VE|Dei@?IN?ECcGpSXyC5m}Vv&iu1y&wu}W z@44su&OK-M7vPqZTQY_}UJycL5mAWLu`F1oYvpTo1N9lKd<)N+So|l88!CUA)*$Z5 zD~)DF2`k1AX0khIz*V`HuQX{uE`QG%>|`Ur0NL`S0c|XV;Jew{qycm*yEQ^QfbWL^ zcNzynY2ObIeCG}DhAWdJ1F>XMBm(scjx@Am*SW9Za1TE^z2bpI6T+}`VyJlIKqa+y z*{~#Of{2TWqGyWFf^8VN5K?b-nW-Qv1uF}RMTgby>A!Jd3Kbh|IDE-8G9e_#aJIJ~ zTyf*i3#a4fI}i1`zi`S}#Ey+YZsp}~9V^mbhcI6q>e{WaINi4aLga>{?Fz_l6+T*p z3Vt#d%ik*$PPg0B|JSn<>4IH{eKl7G98<3d+K?J6M(aWKZDu4yj}qI@Hq*bDKf?zh zmy;Z=Mz|ezkABml87xD*RCJ6w?M^I+ixE$yC()Wu{|B3k2AW)~yElefTie9D<)>A( zzg{c0F3X^;r;IpZGUuoVB-(d#nbyw_dll7p?Xk5F2T^F?EE6(a`)U%9y5xT-Jgg}rC)i^1Fp^v zI6GQZS+8io6N0gie`L?bmf}i$anabT|IVCDJXLrW*6RrAwp*Dy%^nZF{P0W^ox6nn zXD@mBy!z<nS2Uz?bxj0*yu>xBRr&Raw*L**|68 zCk_}LRNi3n=-pNeR1bdB$5*EnFF!JqrbHSDUV#=TTDAB=(%D?epxs$uS}&E|%Un+Px5$*+j0+cF&?h z{PcMJv00+{d;=9!oEIr$BPcw`AJsOksBX6n{Tv{di(PF5aio#WN2|fMAI-rN+loAW zCWi;(XQ@-Mes6gnw}x;`|9kdatp2154koMI{i`iH*dM$Zc(?ovcr&_{8U?!02xxTr zn}W>^A;jU4k)jc?A4ALfy7Mlwz`s|E`eM`?lrK&+}ON$rr=N7eX14;>mTQ5ZA|D1VL@X3o^m?h+|3Q4 z)f4Z$U_uQ&m2h>LnPe?DbeD|L^W$RBVRc~ViLY?U)Y+%cX3PGUM;U%9P3Ca=V3M!-7=_iunRjOu=ixlhUOry0sKgSh|?S|uU7K=BRri=GZ8>z6i<@Q2I zZfN$scVqdqiLg4H!ojKOu9G!bl@ceO{^$@jv|Da!a)Y0bclMU@ z`HT7v8(lWrh7UrExYm7W%3b)w$6vtWaH@xvjQwkN97I)9+o0SpQ}Y)Vr9kluz@%Uw zl+`pMIVK!Ct6Q+Ax_NjY^v?1O+PLpa)blBPRWH+u#*Qwr`(#gQEj_g)aXgkL#flb- zjb1B0A)o1Y%=fvl;i!emh8E$k(^CG5`B?Eu71!9q0HNF`9-wFUl%cuP>d~)AnJhgc zcmc!*7&!0YVqZgv(P4OIcbS+PX;6(^z5PJHV{ToRPOp4+T&?P44z**|0<7A1M%Z0$ z?;DUaBaXPZ!IlG+>a8Fj9py2Ec!!09%S~CS`Dzt0dtx*vZSBZEdQSDmuGI^$G;e>u zW6qu!MQhU%u)U&M%)UE{8XOAVuBaa#4#;ft`ONze8y19%ZJlaZ{M+Fw6kbyn$|h5X zzh`@sR-;B0(?bHO9xr( z&VKuI{*Q+f#tEa@N*^A-z%{aKz%eCllpupp{DbanE_6$c7q1N&1(~G|`cZGE5`&e6 zqUDM#f`nE#GIF88$lVng*9977WaL7FX&N6t6*fbz$Zod>_=A|JDq-P`itKh9pbZWs zjbETw>w(+zM>lW2&JeCb$BV5^8Zhjy8bDD<{sN)V>An3AO`bGBzNvDUb;I(qheq!s zc<}@#>$i