From 42e53e990048d860fe4f89b6f3e3c3e60198642a Mon Sep 17 00:00:00 2001 From: Kane610 Date: Fri, 12 May 2017 18:07:53 +0200 Subject: [PATCH] Axis documentation (#2549) * First draft of Axis component documentation * Small improvements * Added information about lowest supported Axis firmware * Trigger time better explains functionality than scan interval * Simplified explanation of automatic discovery * Rephrasing manually configuring device * Keep first and second level variables separated for ease of reading * Moved up dependency and used Hassbian paths as an example * Indented include variables descriptions to clarify their relation * Made configuration variables tile linkable * Axis devices are part of the discovery mechanism * Update axis.markdown * Update binary_sensor.axis.markdown * Update camera.axis.markdown --- source/_components/axis.markdown | 75 ++++++++++++++++++ .../_components/binary_sensor.axis.markdown | 28 +++++++ source/_components/camera.axis.markdown | 17 ++++ source/_components/discovery.markdown | 2 + source/images/supported_brands/axis.png | Bin 0 -> 10704 bytes 5 files changed, 122 insertions(+) create mode 100644 source/_components/axis.markdown create mode 100644 source/_components/binary_sensor.axis.markdown create mode 100644 source/_components/camera.axis.markdown create mode 100644 source/images/supported_brands/axis.png diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown new file mode 100644 index 00000000000..72e64aeb259 --- /dev/null +++ b/source/_components/axis.markdown @@ -0,0 +1,75 @@ +--- +layout: page +title: "Axis" +description: "Instructions on how to setup devices from Axis Communications within Home Assistant." +date: 2017-04-30 23:04 +sidebar: true +comments: false +sharing: true +footer: true +logo: axis.png +ha_category: Hub +ha_release: "0.45" +--- + +[Axis Communications](https://www.axis.com/) devices are surveillance cameras and other security related network connected hardware. Sensor API works with firmware 5.50 and newer. + +Home Assistant will automatically discover their presence on your network. + +You can also manually configure your devices by adding the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +axis: + m1065lw: + host: IP ADDRESS + username: USERNAME + password: PASSWORD + include: + - camera + - motion + - pir + - audio + - daynight + trigger_time: 0 + location: köket +``` + +## {% linkable_title Dependencies %} + +```bash +sudo apt-get install python3-gi gir1.2-gstreamer-1.0 +``` + +Depending on how you run Home Assistant you might be needed to symlink the `gi` module into your environment (e.g. in Hassbian): + +```bash +ln -s /usr/lib/python3/dist-packages/gi /srv/homeassistant/lib/python3.4/site-packages +``` + +## {% linkable_title Configuration variables % } + +- **device** (*Required*): Unique name +- **host** (*Required*): The IP address to your Axis device. +- **username** (*Optional*): The username to your Axis device. Default 'root'. +- **password** (*Optional*): The password to your Axis device. Default 'pass'. +- **trigger_time** (*Optional*): Minimum time (in seconds) a sensor should keep its positive value. Default 0. +- **location** (*Optional*): Physical location of your Axis device. Default not set. + +- **include** (*Required*): This cannot be empty else there would be no use adding the device at all. + - **camera**: Stream MJPEG video to Home Assistant + - **motion**: The Built in motion detection in Axis cameras + - **vmd3**: ACAP Motion Detection app which has better algorithms for motion detection + - **pir**: PIR sensor that can trigger on motion + - **sound**: Sound detector + - **daynight**: Certain cameras have day/night mode if they have built-in IR lights + - **tampering**: signals when camera believes that it has been tampered with + - **input**: trigger on whatever you have connected to device input port + +

+Any specific levels for triggers needs to be configured on the device. +

+ +

+ It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality it is enough to create a user belonging to user group viewer. +

diff --git a/source/_components/binary_sensor.axis.markdown b/source/_components/binary_sensor.axis.markdown new file mode 100644 index 00000000000..77ece6d1474 --- /dev/null +++ b/source/_components/binary_sensor.axis.markdown @@ -0,0 +1,28 @@ +--- +layout: page +title: "Axis Binary Sensor" +description: "Instructions how to integrate Axis binary sensors into Home Assistant." +date: 2017-04-01 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: axis.png +ha_category: Binary Sensor +ha_iot_class: "Local Push" +ha_release: "0.45" +--- + +The `Axis` platform allows you to get data from your [Axis](https://www.axis.com/) devices from within Home Assistant. + +See the [Axis main component](/components/axis/) for configuration instructions. + +The following sensor types are supported: + + + * Motion detection + * Passive IR motion detection + * Sound detection + * Day/night mode + * Tampering detection + * Input port diff --git a/source/_components/camera.axis.markdown b/source/_components/camera.axis.markdown new file mode 100644 index 00000000000..d7c93a93a79 --- /dev/null +++ b/source/_components/camera.axis.markdown @@ -0,0 +1,17 @@ +--- +layout: page +title: "Axis Camera" +description: "Instructions how to setup Axis cameras within Home Assistant." +date: 2017-05-01 19:09 +sidebar: true +comments: false +sharing: true +footer: true +logo: axis.png +ha_category: Camera +ha_release: "0.45" +--- + +The `Axis` camera platform allows you to stream video from your [Axis](https://www.axis.com/) cameras. + +The requirement is that you have setup your [Axis camera](/components/axis/). diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 0b099a52352..377eadfe113 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -31,6 +31,7 @@ Home Assistant can discover and automatically configure zeroconf/mDNS and uPnP d * Linn / Openhome * Denon Network Receivers * Bose Soundtouch speakers + * Axis Communications security devices It will be able to add Google Chromecasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user. @@ -64,6 +65,7 @@ Valid values for ignore are: * flux_led: (Flux Led/MagicLight) * apple_tv: (Apple TV) * openhome: (Linn / Openhome) + * axis: (Axis Communications security devices)

diff --git a/source/images/supported_brands/axis.png b/source/images/supported_brands/axis.png new file mode 100644 index 0000000000000000000000000000000000000000..557b8ac77aa2102dc354d83bc057a557157b22c7 GIT binary patch literal 10704 zcma)hcQ~Bi_OB#*BGF4k2+@1*ZFHkWiQYyXjKL5DBYG#==!6)e8@&V}N(9lOw^7H=RSA-n0N2}uJu`EueJAn_lnWeQ6nLKNQ{GnL!zOstdE0p8;EUx zCB(=6$CEpCU>|heDkk0rP)BcHTQ3J3MSCd7fk^{m>*S#CU~BL1Ip`pRgL8)&Y-r+b zqOB!m2Ziw2{-xpbgLq)Mad2eh{XA^#TphfbKn_k|cUk7c_AX{7u)Qp^v8c9ywuh2~ zGg$qlmxIAe9Yed9u6C04%<^(fGJaB60EmOPEt4O_%^fD?C(C?;D}`>b2A$|dIUO@pVQE@2& zL8gCx%vfn&_Ks5e%Bug!!uDjDoxQz1r1<%LeSP_Sh54XfPW*zBl9K!aLi|EPyjTie zn7_NXtsk#DjOE`5$__9)FR+I<80yaS7tt03_3@Tv#%lU66CfV{fpv%d<0h=b`2B1> z_yzd{{+je}LT&B;Hz@@2A8MGlzQh0M`+o(78TxxT@asFkpgvx9*okvw`76ppO3BN? z)*I?&2!*=++lzY6P;V&A8S25LWFX2X$Ycz5w}<+|Zs@hOr8L}O-nQ;`4jRg`%vc0I zFxXy7Tu59}L_|egSX@;=P*6n}AgL;-s-&tcq#`H*P?ePYH?K0(&IjV)?)`6G`~TsU z_^-TwLjmG}m8|UG1%BaRuj&PbFx{9e1^(~4i2hf+e|YWxyDnn?m6so@4FBJW{of|~ z-$U5w`P=+Y*kU{X348~4Y_xk}!*xFK^V@}!Fff` zmLY9E$w)If^QS-6n3K0CRXZE|`U9QX;L_v_lc`Oyu<#fTv#tJf~vyq6HkVn%?%#lac#Eu_>AmKplJ`~Bq5&Wz}0%qbqj zJGvApegCGXTf+Pa*LwgD8n?#xlb%u`pB1Z;dw7Z@ZyVy$0IBjAD&y~?GSnKCdh>$A ztE=jz{EfVxfepR#Y&G!0a`v5GavU6mF~DFh+mtNpOGoJFEf5h74wH%2L2+C2!ZexL zE0fz;brMFh8V*L9W|xcp#i0i%8#E|n@#25-*F?a_TznOhAnF5&8#oCqK3}b+=91m_ z`*Y?#Hvm8Ln{+}rB0~Ry{iLUl?^v1`pfB`R=4ScJA4sM7i~!{544u1?{z1ANA!53T z#`&wt2S%)y!?u%J-dfW)BrBc`U zpxLO4=Eln}QLRZ9>+Dv5>C*p zg_@a#4XPu7;HEF?EIlGw_zyFl*ub;mJ(S15jmd_DtOjUp*PtfZ0O5>kTZ|toPs9g2S%c>n z;3^23H;q!`kwd)L)9&y2Wyh7S8#AMI^VQB)?kSJPcxM1Oi{oe2&cqnM;)q*Zkt}aM zqIOgaR3LkWQt7l!Z%;-xN{!)%kj;0^?ww z`GLjd{k0k%0cC5ARG*D#GI-0X%ZEXISwOAG{WNV*0-dKWrQ7?mEjj!F}^pPU-u$G zCF(8#+Pssrh4eZMx{zXF11ef%-vEYB`{Lfk8Wd5K2n_LY@W8bFc92PF}e2Kb{# zcxDxWkcde3fJn!6pPWjOene__R@zcJK#Dhi2|O@*t<|T@4DT<#Xy|-`xZNxQ&|mA1 z{Yt%8^?f$rosE)7qF@N7D0{N_7i`mmWBqv^{TuWuRn^;b>K{t5!Rs%0K>@oWY62o?kV-^+aOdw5eHTd z$3BuUt8Ku|T7{eQrZs_M%|M(rOP#3;lk3U{I>H2WyO#FB`2IiUD9{T+N{gP+$dc#) z(1=UB&(!I53gQH>zo#^E@+0b%UU?K9&^kS^hD?#AmHR=x3-5a(zraZ9)N-FH6&^g7 z@w2|*y!iyPyOuLcldl86oOE+e9&`ib-q5)mC*%Pg2F{Kn&THc}=t=Dd8FB*N)$lDt z0x;N|w}QU0^y0d@cQ&n0>TeZ$+kGzeF{`2*5sX-*+T-Qxd325sztv8hNtWVNn%)nt zD+nj04wMYo7#+}}=h|M~$-2}_>MRi{N8`oCiGsPQIi4I&`SS30#fw-EBm{wCb0OjT5BoXzoEiVdWnFam>a~Mv5&x_-u`;DA#oLF`5eBR@ zs~+!vYARj#h?SD6dZIjIv72TZ82qM~(d%7p0f4k`&G02*speRdp3w0%9q+T)TYvNL z0X`lzgl+!zYi;?eRoxlVuMnQ!u*m5<(WyA`Acy@3EQmM-LkvBdd%ha zWFoFl4YelE=dp)kQCMN3%ui(SP~pgD;4pbZv5+WH%)BU@wAbg?FFzQI+-l%RYb(bm zWmfvD`-O!Jii>5OYR^(sO_N!Qc%AJYGTr9rjw&YPk#+(7U=1mr$RRIdWr#O4u6`= zfV%rq8>i(Dc`-Gt59)i*o<9MV5s0MYwT(J+Pag5S)fH_q8vqn83gO3dY_Wqr_mFAQ z_U(Jxrv@-1ZabQ{$jwt`FKSlkyl$ZU+?ucaoRmuQnccd5 zc+k7?FF{-p6ErAFqCScR1=rf~fV|FMi6T6NM6RFXAkxY~`Y zhtY2fb>=M!>j_*%LZrG!m(R%9vXnAU#8?)9GotB9^!a@+u5$u*GTOdc)pm3@15KMr z&%{nMT{q~L?p~OGXkz4{Cmi|{;>_E^paE9Xa{ARiB$K*mf_PASyd;i`}mh( zTBCo6S$6`tGUd;xnL&d}9Qm`nWsB1jJHjn1mraTMq*_*?7;Rnb(M=|7ugYD$xQmYi zRwUv`_!R(bhnROO-%DkmwUDRn)7%(skSFg=vHk{!sWAdooq>foyF?{3&wtlPZc%Ht ztehP2eAVZ85{on;oc0dV9BXzxCIGyjmI^HWnWc4aQnW}z^r4Gu>AUil^^ z@C9Pi5Bmz&t%x;vz-2-YnxB%xYsDqgvngge8{QJJi79?#s|G8~_#}}q_j61`ZE#tg zmB@kBQjsRAg=}loK_w-%LFxQ)l zXIyGVuxr0$I|f(ey~NSfX_iN1hhT zg~#kqN^%uMszOM}6Tw6^F@gLMKk7}qz+fIW%iej;f!5!Qn_-x$Ab?cFFu69-t}3`t zx#+uxL|ro-8Ia+}#DoNmkl0M$rVVtldTA^wv-W(y_103=JV)e<3kuX%GCp3C(0~~h zD*3RE5!fnxcbbU~?+?S~Zl;C@-T3+glwx;4gR-6*#*Da64Yf8g!DM%Q@q5d0+n`EX z8?qdgD#JpkCFW87V37tJ8a?Zumfe+k8b9S@EsdRwP;DXW(#h~>Z=+`?kR>ZqrOl+| zpa~t?9w0H2@Vx8)K7c)3T-MblLo)r-?BXMqBbHhE<_h!pkh+Dphx9`b9)rbAo#q2^ zo%!30yOZ$8Oo*O(5uJ!{%O(B?gTf`=>9Fpv>`HyK5gXy)u~oU!Vh!Dkxl(IKFOZ>B7iLuKZsl_O=O!jKx~@>RCbFzD%75*ue&3fwW}98m*B4@UiLBfOcnue z?ZrIJY`L1&eeW>* ziDk_QfnyUYD&)7nCIwMec#z%G=IYkhDycQc+j7_6x-k2lu~#vy=IV#UB_JaCTJP|u{?Tk=X{uSDba<}mtq{LV{$y zc}usyuimSFpKs~0-L~!<=NZsP-`!*z=(WmZXZX66_-*)y+=-TNL1NMlT#Fu7S4OJW z=QNJas>1V6k zW>mh5-)Dkz^Mtx%9SzyuiGwrg*mO7@0ztAH5994!AKVfiO=!Qeb7e}9r8%-{jV=WY zHk+eFd9SPHDx$Nb4>GIR!%Pe~DS1JI$cp~>ui>6^5=une)9jh%>OWanT7&1;R;$++ zw)LSF^X$Lk^bcB&k4EZ`Wz2?^?BSaA7M9RHIr~>S^Q)Q{O1p~qP%DpybtCw zPeNn%!W|XXK@)_J(uX^|f4eSvN(RIbhjh#xM+zX;GmmCNpHaEPi(YrpFA^hzj@X;P zKpAxw0V>VplMh!-@vU@D?w_d2PkrS-9mV+$cis!L@oHTSjBlp~@~tXtoFdmubtX$E=Y^cKc)#`>Nau?H)Ha*3Od(CYw&C&63~HQdJXj9tFX<*;9c4e@u4?D7f{uqapbQI2Tu=DOGb&7tGzstxOxaCFIAjs0H|BRpQ(&)EkUVB*o3CXSSVvM$;% z-AQdTpH&ZL>BYw#&Cf0y3^^%3D*i&?4>|V_uJe?E`Fm4<=m->X&WkQv(WSOq7cCt4 zMxqQ{!sN0Cfkq%Av^m1(bdD#oj1X35f4kGxM_32XU^9x+G7eeTa#}+VeEsI27FPg3 zX5qylm13&;c|O8mCVkrIT%Ut2UE$*Dfylgz6wMFD7cyCvZ7UNIBP7`@w$E~7`UC;* zXF|7GM?8j<9Ti)8j~&d683z^Ql9ShH#`Dqv8v3ojNBF@FR3j3ti*(qPVrp*iKsCzx z;CA5;hb}6jZ?0{2{bgG%5~K^Q)1s<82WKtUH4OA514YGdlZHI4?srcYKdr1MU%H>w zkC6kJ=`N4iMdr&LDg9-rw7@i7mE7Wsj{%(O(KD@fpJ)$7?Xqpy(#XU01&tOxqpS^x zS?lSfy$2vKP9kOvKi;`@NqXB1GejRg!Lx{BmlW0MofStG#6*b+^QdYjmRf%JHgh_0K483Bx@3`kzcxQv;ux?gEjHcM@Ki}H+l2d18 z%_p9gU}hL(|Ra_*rKtP{BxB@ zkhze;){;yALme(hp&h|+h3OhRiaP{j6cr@6 ze9-+xKCK(AZ81@psw0C)uY;DgzVtV7mtdE$!VMJ<}XI^q&*eq z9&b|9lxp@9ek*}}%v69<{ItYh^qj*?t$86H88w=K>}-UcQ-!L?M*8!aN_{7Q| zeHreuE<$-h`b3#&w^eSqNGftXxiXonK!dq5-{5y2@SYp=PtLsS#psV`1jOVNekVo> zv%?lj6}~ZiOSpce65bB)6ILt zt7T6u5=T&|^raNo*Lhj^Gsv7Vh-v2fk8XXz&sw@t5IA`0f$0p18ef*j_(aX<3@J@i z5kHzd5>JFvubo_T(fh?K&%Sid2qD-2L#c>~s;~~9@3dI<3>6T2gi;39c4l1-W?%nl zZ97d`1diRaZ2Kk<%V4|c$+p!_xElMGQuBpywK=f^1FC_2ZH_QmJsEFKc|@G0sk%Yi zBL1H9hu5?|M{#U*Z`W1bbZOQKh9`*9x^wxm4A}fW%x9#F&HV0bp}@+~Lz}p#YPpbE zYTwm&r|g#UPI+v{l_o-`+tK&5oCll5LFkV>c{r8s*u_oZMofq!Tvkg-e=her{V$X%?AvDQdewmYeikQS-%Yee#4&PB@NDZ&u%lBrxpj zT}hB4)vP=vmP{$g;EDk0AQG(ub^i&4UuAG3lnCX-VpMrk0cTzIg48V`_UCp!yNvGl zIdqMWd|Ou1^qVL(0i0=%3&srs3A&oMi__R*Y%7bQjE$Gl z4e_fgT1*(YQUTRn4Nj%?hPx;>l7Vm8$=V`*4nOSJp@<7A7=jSLZ!NZU^AXYxdU z3C7GDxA=fdn!yA0L7WqD_J~L>BgnPV5pqxy1l~Af1aWFryJ4DKo|>U^Om|tbE%-}t zKii$xl=+wjdU^kXcD?@I1=oCA<)WHA-~cR4^ZCfC8J?ml9y{v%`2&2}cIBb5b$KPf zM}Wd|5u9l$w}kOYTA)dbd?p`l7f18#_r#%vYt8o6&(W;Ho+7>V&iBSn8MFnRqZpD{ z6IwGqIo&aZy*=$MZz?9Dxi8b52AJcvwa$8)9%X%#B(4Jq&B8SiyBHte$*|NYdSp)a=sjiKD)tOTQtC2{9!ee`9X16L1yE${$>13L5#=yAGGkGidjcG=CpLTKlY1*c$=#m za(A4iTfaVaF2qQV&-vwkN<`@0HMx^Ig?Z=3NxA6hzkBeE3RTQGB74y6IKK9SE+!wx z_4v^|=*PREDgKS`_!?0FPVz-)w?LY%)9Grg`pOm4XfVdW7|H2^Grz3Dz^6V{CodGbzLFMqJKp0lOr!lQy=|Tl7j6ClaYRtR;E5DlSoss9&oP%ny9_fez<7 zXj!E>{M2Dsd*D8N?>D<=o8rtrrj+~7qKrXZzps3~e8wE) z9FwbMy}JK2JjPVJR&#HxkO;?TRAb_qS?H)MCD$g|$4TTL_{J~W3M8f%2PYGmv$g(qgAvTXah+~;Tor;`D5AR=Yyh5 zHBMAh*`#8hm1Oo^9%ALo0yeyiL+lJ%*(|){UE7i-r|zo!*Aa+aCKz~yL`j_`Gkn;?hVU!TywPH-$yvX4{ zdezo@nDkU$&S9eNG*8|CdV7~DuZ3MSu$I^B*>}?~LevyAsJlj;Y6b=CLXO~bBm3<$ zR!2@gN%yzp1yqAqAAUA1a6x(f_(yuH8<%Qm806Kgf(ICqs&*sKDoO@S(`Cy!_!{HR zbfzyEV8&;=PK+9jemN!L4Kq{)m`WR*1|QIK2PVE1`_Jv18(}79`LlPh_a$?_ zD8q(Nrz$*DmU{2n-#jP|67L(z)s}$f#S{lza3BJgYEtlL$Y(&?>uqXI+E#)GvHR5c zz-1eE*TM=ZQue#d4PUg0As}#FZF0+ds>y%BDe^#Q8j?0>+th#Q_OpNw9G`;9tT9G; zvRuGRpYi37utjzDr$_HY;KHBIiW64_|o#}HJrbh~@4hp>~Y)k*oqVizJbO(O^I?hpF)F#a## zcR8Z;ZRHB!yY(%3&kfHVe|8$Z*RVF)iwg=7tL!dPIVg(SPiZVE{!B8U_+|cNe_|tB z^g3UVH#ZvTgRbxlq1^&xu2qc(B;p!OrRczHn|}!{IEGxDOl4a)vn}OhPb-=~dS2^- zR%x!VagRy!?{BbCiaMofT_TSoz}`Un1K2G+U5;c1NFR+&RiUOP;HT3llWfD-KepOLUwDdI1SK0q3kMBdAxq+NlM^K9dN^wZ95k4=<8&kU3v{h!J80y z`0%pw)1B_L=1+O*^3HbJ;8dBJx%9=UU~~97U63x`Y|Rc#uNKilzFH=0_Y8%5ibW< ztbkYd_8?>Hhf7>02IY>XR{8bX?ZP$4mvtY6YBCrqDT0Q-<%u_y_v624wVs;OZE~q( z)owz+`LP&iy&+A_OKJqnSDvtxEmn>dwuFkFNb+?mEq?#@f)lX=cg(rF`}~gGuGXSM zcy&9Gq2(HY9C%Do?6d338+Q;#-S0Y;{o2Sn`7NBpl!pYFbyYsR>D{PC1rFgdV*3#} zFryMN%F_W&&+~IS>sSEBxw=XJM27V>INJvE`=;kNBiIIO!+oY5EhTzWtWbukdln0V z4ITE#dz$eTu6;Qlo=2$giJ%&ce)VoN?qmES(xpauk30L0F7)TAfKG`QqV}k@U3lXc zxIU7{cyZ!47rD0osDyc`yoF!=(f0(+N0ubYE0CC=LHWl8PNh{aT&uMA4|+CCe(_5w z>&yQ>*E>SzCt>6qe|4Ig7{rR*GTt^~9!$(>FPCWgBBYay|KhTg=g#t;agj$?w)L84 z)|wciJ&we#wIFBbI8^jcpeYaCeQLHC-C|zey