From 6496e3ef21e02d8c74cca9fdf7bb44c7bc26de33 Mon Sep 17 00:00:00 2001 From: Jerad Meisner Date: Thu, 25 Jan 2018 14:25:38 -0800 Subject: [PATCH] Added documentation for Xeoma camera platform (#4405) * Added documentation for Xeoma camera platform * :pencil2: Minor changes * Add periods --- source/_components/camera.xeoma.markdown | 89 +++++++++++++++++++++++ source/images/supported_brands/xeoma.png | Bin 0 -> 6530 bytes 2 files changed, 89 insertions(+) create mode 100644 source/_components/camera.xeoma.markdown create mode 100644 source/images/supported_brands/xeoma.png diff --git a/source/_components/camera.xeoma.markdown b/source/_components/camera.xeoma.markdown new file mode 100644 index 00000000000..66603dabb3c --- /dev/null +++ b/source/_components/camera.xeoma.markdown @@ -0,0 +1,89 @@ +--- +layout: page +title: "Xeoma Camera" +description: "Instructions on how to integrate camera video feeds from a Xeoma server in Home Assistant" +date: 2018-01-12 20:05 +sidebar: true +comments: false +sharing: true +footer: true +logo: xeoma.png +ha_category: Camera +ha_iot_class: "Local Polling" +ha_release: 0.62 +--- + + +The `Xeoma` camera platform allows you to view the video feeds from a [Xeoma](http://felenasoft.com/xeoma) video surveillance server. + +To enable Xeoma camera feeds, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +camera: + - platform: xeoma + host: http://localhost:10090 +``` + +{% configuration %} +host: + description: The URL of the Xeoma server's web interface. + required: true + type: string +username: + description: The username used to access the Xeoma server's web interface. + required: false + type: string +password: + description: The password used to access the Xeoma server's web interface. + required: false + type: string +new_version: + description: Set to false if the Xeoma server version is 17.5 or earlier. + required: false + default: true + type: boolean +cameras: + description: List of customizations for individual Xeoma cameras. + required: false + type: list + keys: + image_name: + description: The name of the JPEG image for this camera as configured in Xeoma (without .jpg extension). + required: true + type: string + name: + description: The name to display in the frontend for this camera. + required: false + default: The `image_name` for this camera. + type: string + hide: + description: Don't show this camera in Home Assistant. + required: false + default: false + type: boolean +{% endconfiguration %} + +## {% linkable_title Full examples %} + +```yaml +# Example configuration.yaml entry +camera: + - platform: xeoma + host: http://localhost:10090 + username: user + password: secretpassword + new_version: false + cameras: + - image_name: front_porch + name: Front Porch + - image_name: back_patio + hide: true +``` + +To use this platform, you must have the Xeoma Web Server module enabled in at least one of your camera chains. + +This platform will parse the Xeoma web interface to find all enabled cameras and add them all to Home Assistant. You can +hide individual cameras using the platform configuration. + +The `image_name` configuration value for each camera should match the name supplied to the Xeoma Web Server configuration (under _Path to access images_) with the _.jpg_ extension removed. diff --git a/source/images/supported_brands/xeoma.png b/source/images/supported_brands/xeoma.png new file mode 100644 index 0000000000000000000000000000000000000000..7311d88d972f8ca3d5f58e7543ef37b2d59e30b4 GIT binary patch literal 6530 zcmb_hXHZjJx26dREg-!F2pwq=LJPepMJa-Uid2!_4TRnaDoAf4QZ#@lQlx1D(nX|& zCJ+q$rS~rN=DqjteYtbL@0&Aw&dfS{_S$Q&S?774wV#_9>C#biQj?I7(CO>xn39l? zwh~7ZfRbqGMvp!uz9{W)>FSVN{QVR(mZT9aKySSVPf19qxBecaT4k_oqLB)rZ+L@h zmXwZ?lg$eXDCrl&?jfQ4#dyRbf5W19?_sWEd>seGg#)oVIo{jz_ zh?*NCBcu57##%EhW}Y!u7bm{d`n5;%MYO1iy*{(h&%r0Of|T43m~R~1K2*Cq^6=u( z+5+kHZR50H1t-kO38`$G3q4i)O6>l~2P>*%LH$%gf}u;r#Zj;sOf2o{T|P4YYdVon z7MCU++5j*ORD>GeJ-s{QAwnWldeU!ud6@{bIaT3EP0anW!HrI=joasFzqAp_dBToP zEL`h6K542t>6Ew6CMmmq%jiu+CZ#hCI)ZHY(KBwu;-{%HF87=ybk2`j0(c1qm1E#| zrll+V5_;+>^CDEEnD0y69GKAvOBc%fl(!Pxi zxp`b+u{kkP(q=4>x#(7R<)<%c+Ejw_r?{|tE*uZQz0>tp5BIpqj--LQn!Jv$_ZI8=1Xw0E~h>N~GQpqQ;i1Voo-ML%@m5V%Ag z_oeST)%1@(AS72ONLGWJ1v<5i>p3|y#YipXL6Av%8Zxv z9{E05VAXs`<6BGE-cXe8$ETRIo*nfJ(5G9*YI5*JxbxdW=u(6g$KiuW z!f9?**>d0X674aNzcyW7c3*OR5Hc9)SJ~5SQ^8GR6_z{MeDUN4a+CCIYQK_G@z0*> z!eZ>vJ5WA<=nmrvml^bU{>pkGWdr_;!0?QJO!$`sj8%%-NUC|5#yj!8*GJ9d%u;#K z^lw%}Mar$G(VW=DUwXmLOd{dSH)P>B`-71OBrwU_X^g{mp`tN&m|k{g9neFVH$M*) z&a=MNYC1X9#r$F*a{zs*sfeelx)t}zSW}Ft=J|a4U~ODw3(M^jaka7gR4^9QL%ygr z4sk0az%0rhSbNxdkFJnDz*dg&Yb5nIirb?+t;LZ!H+63Y^R}FX_=BZlVm*Ip$KE~L zdN9h}>KySMTzGI-HM~e0#en&qcS@@AKd+7#j{!Cq>IOf(s_(0Nnd5p3gGmF?OZGfS!`Yh7&Au)sWZ=Ut_*LLv z4G?WC5%W#kD2_pM0!|AbMjTJyGW|%-kNh`I$?qjUH#yj~2tL(_s+20&4vqQO&wQ_) zL0GRVGG&hpm^A)Z;$`_lTZ*${M?O5z_8Y$>q3A}fY}=tSFvq&nL!ULfOnNl0ap@WG zwkF#*=)F;J>kH|YVbU5MA7%s}uy~yW=uBH!t{lTOkB7_Py$A-X9SkcbzTIEIeB_E% z2m(X`2OCcruy$0sBiyM;HCP9e<7;D{30Ml!9%BV4zbEf0n-40A?kz#pbtPZz2rOEq zw_`G)Ej)mcbS3#BL|HI((O0ck%U3~mMl*>fCl!{A4(hJI3e$l(l$3gXe^ay0cHudKw_JRi!!xyAVQ;!V9Kd*noKSJZAN>F*O9Z}_Y} zioKvh)5D*wubsbY19Gom&wC|tyN_4XBMTOIQwfzSMPF+FmZR`hLCj(W!j`E_T;hCy z%&4CmWaW#4?YNax8VH=WoosbWZst}f{Wb)Tz*5{OHKVSjYG9fCPGbfMX%}pP*_m6{hj=lZ zJ)?w7Y5I378VazU;>=V#RjO}Go+hIr=hN0WRe!!cgznZ+$ah~t+C=A;nBK+Aaw9gx z>o7JQ#d4b^b3jI%^g1*U9K%^a+hg$LR}F1*kQ;^H+2BRM8uw5U&!-ulTXm|m-Q5C5 zYYb$kb_R0VE``#`Zo88ik(f5>O1k$gAEFBfi{!3O{BJkb!Wts}dUh@(MohMeXF!YURQ_W{QQ!9L6T z?&2-&+2V8V8%Mtv7|MBCb^w`y$oU3*tN7DV0aZ35mC)H8<9>mPEZX%B+AxCTT&G}78Ist6I9iYk(P$QX=Jm_JVf zI2XAGrtPj@;!#ES)0M^=R%7>3)Wf7JfN?79l%ofsQdCt|#tfw^IZQEZdq;TC)%NU_ zfIUsf_?tr7LeFEDxKRQ2LLLu0W#1a5*^q_dp`p;?W@-3+Xw|vzqQk&``5pSm@)5Tx z<)(Wy!x4@*_sZQczdww>fn@8U^MhX8MVTl(m?W^=c}!y#IeaH%DLHSZOl%(bJ%Sw! z;?N@8y>L5Tz(UYsXkgA(AHYhJ>$h~ng?p32>}&cL#0})Bg}($EP|RlvKiuhX=`s_3me6Xpg`ig&#b6{JKk2;?FH#|HjLJ`~OBTYX_eymBz!H-7DEY{v%Wag@Yvj zFH8l!C@B^8+*{&uE`t%`mkKk$PL-r{Gyg}}P8S25;@>1o|9`5r(U2RFK529oB2yjaDm@whAxiMgX7P-fjsC zLfxy5B6YL^$(s-h4PWe?J5we(3}6-7CQf|d#Du4$R`~|1&X|K}zkj`U%fpo#2TS*H zm}zM&=bxgYo+GPk%E*-?Iv?kGsqxd~TGDQN2lfiO1nEsvlf(@m7Rl8L^d3~xQ|7UP z&)Rllp4~T6Jj>~0WHctsNG8-bjB~)#Zu{5c#dA_tb7;43hRk}`yGnMbSR&wQVpOU*kdDG zL~%FoWTNqN59Qcih(FyBz^hh3f-EuU$PgJt3{O0aU6U+_@M?hCBm$V@9pG7g0-Rjt z!vOVa9=GjX>5p5bjP*XZnKedHZGYmdI^ibQ;gh5DK;_OvclrxaHd!j%_Y4~B zNO@WcHH40Q8RKNl?v3~n*VJe~f%H$hw14Q##-{nh1QX6|8A)tysi3IgxZG0j&$fOkQ6P`iOxZ{^ zTluI8Vo-PMbBVz|(A#S82{n#>Ud%@w9=3myRdMTOnxT{l=8kd;Z$jU7D_2&H$;M?z zOe<#iOFeR~mXtib(mndl_C|n?kOR)IOxUl)XB3osCFs$y)*G=dW)SSk4KO&H`)OxnW>6wfZ zp?SC(Te8KSy^x$Zp3qyZEec*p?z#0_h(JpOLs&JZB~fJl1Q!y4hA_^6*CI+{q(zLh zddC023#OVVW-%#{N9JS2T`2>35Cj0B*iCkKY@YALmg5rDi9XX_(&n#~UQ8CeL`v>y zp`bz`r61_+cWN_Je>480LLa1IYXyX4Yxs%=dB~3cB_V&31b&Ouwrz`LY&+NDSlVxnO8WtvM&C8o?(< z>QXQNRi%rV_%vqhh2Wy^j`GD*D*Ks{Xm@5tv;sDpcYHShK5LW;d};pVRW_;4Jb$M3}=@0j{NN^ot-C_ z*Za{)QxAwVHvlXg6MwrGTuZ?`Dq?k*2vrh=M=bFvy+W|hk-1LDWKhT{^I;|#GJya# zD0mh+3Bg77NEMq!P7dH|A`nOA%3hzd17V^>e7ne>8Kb@^-LL zOYzL*n#SUD%Jt>HK*VCVejg@J;U*0p=^R~*oVg{d{XSahxck{Iz4J}ca%1=-Kz_)d zdvn1?HTlBDLs z<}bBMJ&jlo39tZoc$wBHX!?__Qu8*oQJ?KsYSU8OZ5#+X0l$y50?}?QONPjk^c4gi z)0pN5t*lHY3Gjg2Y`>RaP`$K$*D3>hoa!=cdN!2DkYkI*vgg9}xV~59XB0^*0zYJV z4rC|K!RoxjasjHdVW5)s6N`Egf3FS6=Z^0YOzy#(at%XQL)4}hdna=1IaYv&{nLB- z;W1!H^PF_CjstvhA!|9eI{uAaUS?UajcV9vBOzfvr;ymD>kNEb@f>DP;TQTX*Hq9p z+rLC_2;f4KU=kJRk$s|(th`yoaw_TNlV=>svAev?*nrSIDj#3<>Zk+Tsmx9;WS7S7 zZ%e(vv^`vsue5D@7pNh-I4Qh+bWh;@YW%PIs~H0(4b z=|VaHD@pUVo!cVsZ&b|rvuk~9NkhTurtbJzF!GV5Ebt1(z zHLJOMbu(b7A+LV4WXksE1@;!!tcYo`Ic3h*A~ZqPj5nMySh8Up*CpJjc aLB4DmxgwjmQct`sA<@5Kq*JbC8}(m;LCPWk literal 0 HcmV?d00001