From 2d86c6d96c352c70e0a30baeb051bc7369e94d50 Mon Sep 17 00:00:00 2001 From: Robin Date: Thu, 23 Jan 2020 08:36:00 +0000 Subject: [PATCH] Add sighthound docs (#11203) * Add sighthound docs * Address reviewer comments * Bump ha_release Co-authored-by: Franck Nijhof --- source/_integrations/sighthound.markdown | 52 ++++++++++++++++++ .../supported_brands/sighthound-logo.png | Bin 0 -> 4780 bytes 2 files changed, 52 insertions(+) create mode 100644 source/_integrations/sighthound.markdown create mode 100644 source/images/supported_brands/sighthound-logo.png diff --git a/source/_integrations/sighthound.markdown b/source/_integrations/sighthound.markdown new file mode 100644 index 00000000000..ccdb48cdb9a --- /dev/null +++ b/source/_integrations/sighthound.markdown @@ -0,0 +1,52 @@ +--- +title: "Sighthound" +description: "Detect people with Sighthound Cloud." +logo: sighthound-logo.png +ha_category: + - Image Processing +ha_release: 0.105 +ha_iot_class: Cloud Polling +--- + +Adds integration for person detection with [Sighthound Cloud](https://www.sighthound.com/products/cloud). The Sighthound Developer tier (free for non-commercial use) allows 5000 requests per month. If you need more requests per month you will need to sign up for a production account (i.e., Basic or Pro account). + +This integration adds an image processing entity where the state of the entity is the number of people detected in an image. For each person detected, an `image_processing.person_detected` event is fired. The event data includes the entity_id of the image processing entity firing the event, and the bounding box around the detected person. + +**Note** that in order to prevent accidentally using up your requets to Sighthound, by default the component will not automatically scan images, but requires you to call the `image_processing.scan` service e.g. using an automation triggered by motion. Alternativley, periodic scanning can be enabled by configuring a `scan_interval`. + +## Configuration + +To enable this platform in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +image_processing: + - platform: sighthound + api_key: some_key + source: + - entity_id: camera.my_cam +``` + +{% configuration %} +api_key: + description: Your Sighthound Cloud API key. + required: true + type: string +account_type: + description: If you have a paid account, used `prod`. + required: false + type: string +source: + description: The list of image sources. + required: true + type: map + keys: + entity_id: + description: A camera entity id to get a picture from. + required: true + type: string + name: + description: This parameter allows you to override the name of your `image_processing` entity. + required: false + type: string +{% endconfiguration %} diff --git a/source/images/supported_brands/sighthound-logo.png b/source/images/supported_brands/sighthound-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..3a100832c1849c424133c32dc3baaa19c27e9ad0 GIT binary patch literal 4780 zcmd^D`9G9>_qU~O?5eR3QIur{Lo>Ev2Fbol!Wd(TF~f|t6io)%B751hC9;#HY;hB^ zMz%!uH6(k_xSzZG`Tp>|pMT&vKU~*2=XKuib3W&s&+B@n6$2= zjA&?RDOBC`6g~CnM=qP9zPL#079?Z51IZihfu&Kk$J=2+S~#>L)(DHX_jPZ_D$>x< zi#nTFkSug{;21nk5`7#a>4PIs(KIxQDn0}>#sy0P*-IRpZYTpTgob8o_%%Qqq zT>=v8G6V5oz0xOkk307rUY(ImWw2_EnI zyNd=+coLrIgeQQI$UnOV64gaxoZXI{Vt=A^b>UiWL=xH!gVjPQ2~l|@ot^FBNU)l$ zoQ6CM3PFM)5Oq0KBoqomUW3WXOJBPNgUS8IqVO0`9M+BW8*Bd`tm;2vj~4<*pk_v4 zJ)FI;_8J~|9O%!3!=3-R7WseV`wMIT&$V3pN30aJ7^&m&{-1IGc2RfeSp9o>sm9;y zk9DK&ya#o;KYwHxrrsGE1056ft*xz%jg9;MA>G{{J>2it)HL3?;|quBLS?mz3QJ?6 zlh@bRqaqV$XXhs-CbX{KI)6?=N5{Ievuk*GI3hg0v7y=21REBXFgZDCZSCes3XG4> z$j>ioZEb^q)w#JLWo5NhRd1D)43?KylapU0CuO{S+nAA_i*xlG9v&+%uMP~12n~&y zpI>Zi`-6>542QcnF)<|sx^_uK@zbY~fq~(|!U_(yE3K`ab#?FVID3zcP1e^p`}#b3 z`ZN`5Pb?{}FwnDARW)g8>CjZSpirU(1mtRK>Who3<6@tq)JzLr7GD)ZG&Hn|T~-#o ztYmLbva|D0N13y+h~?(I;^Yw5zF`HHL`jOPi3lt3^U4zN{+1Tb2xX(&w_N)A`V0-w z;#XDm^latjv~{&_v$J0b35hK)uWN2@UtizI&MxxxrQEvZ^7ZRCNl9d1-_YUV;m@Bx zkB*M|`}+?L4yLE42L=XudwV~9`tmBSmX?<0=H_~OdOm#U?CAI~K0aPu{jR&aKR!Nnb#=A6sw)y4P11<8ANDc`?;*VnW0@h0=|NIN=u@$t#3B8)pbdmoV_cXoD3 z!~i}X*~Md7adPyWnwrVYE$-;}cwO`6&6{_6dIt4$tY2iktf;8Z%6jGJ8x$HES6ln` z!Gp&pMws^Y?zi;~U0r>F0b#qldnwOfq@`xJG{4{7-Ltn27@6cCZvHtas>rtZ{M~=MJ1ta@jxIrC+Br$X2DGhCo?lg zDG6kDcEMdg%9}TJlatdX#`b%A`{iX-KYsiOdK8(O@?v#$y|nbr_ObjVdOS!^&(F&% ziHl1U7gwcD!5eWOME&Z}kc{+Y;WqBp=vGO6O8t1sc*^It6@FCGT3YS1l+WY)_iJS~{WrThb;YA! z2aKUi2q|d7YjI46Sxsm+oP(Tef4aFnhMlF?@-kY~sw6qu{>Njr%<9NC1Ix15=ns9# z0vv;$qLdjydSL7p^G&_-Awyt%ea{6W|LLXi3>$wN3yrNIHek_t3Ce)7GfFz;`5|*` z=}vnAimci?IbqJ|Tvx69L5nzbZ$*W?L8X9;_M;~=njX^Qn`rvU5p zo4PjoS8|=6D-Il$zk0LHjvEQixZbxs($1x4sr{Vm>ClbOVIgw3=35>qS*9JN?mzXa$4WXd1A6V9aQ! z8m?iI@%{^MD_UEE-qhnFq5H}_U{|^*k{n-%EV=X<-J9T`SkPI(x75qCtC*cLC+xVc z{3=NQac|*1E3nc%dD)tamGVuaXkG4`=}%=(xdTYKjtDRoSoH8@&1JsCE&6Q3X@nM< zQ_oU~fy_?7rgwwm&VCI?v;$apl2^O-!Q*U%lJ*r55k@J(b?pO#PEwA<+ z6&KM|I%uM;ft>|C|J>O+J^lJQ7ZLWbD0l=Wgmz{q4^A8Wo%3btWgsUoo(v54EF|cD z1b+m!8KjjDuenpr&kH8!KQwj=>f@2PCMi7Cl??qS^ z2ep=Y&N93iKM%N*VxtM%$txy+XCGV-U_H0s;UpOHEOF#1y0wyA<8oe98sXkPy0s|$ z)B}SNJpr#vGoHH$5*070e7i3dNqpHX)_cEt!LIL~Nt00Lg5%K*#Y4x>+z+&xis=;p&^$MCNPZW3 zUGakC-aapk3qM%VhU(CG*_;GM(0{W=vo#lpRa@%Nll7f>cKcIIU$hll060CPe(|rO zMiZTD3vJiy?;iE9r4{{15C+&DseP9{K?yZTY#k0sQSjDqji=l8s<)7Y4t7FTv)Ie8 z6cnPbMbu+)0FyI50^C-QzwuiF^TH<2TTX$4FOJ894fF$-kshK*pdzBgJ5MK2Lqj{c zDJZ-wX<@SL^7Wq@rUD)HtCgFw(Q`d-R*pb?w!NHS_G+tC!%psGiJ>O2xkcWs&~Z}FmP2|K_hz0 zDTbNRroVB!Nx;jZWj%Xs$F~DWi9=-PFY+5iGM|uS2VHrLRtuu@1o>tQ)@CeXIVo!h zJj)ZaY2ZCG-U73#DQQj^eDHz2RYA)=LW=GOi=Lj{@QGzxe7^Gw0(#A1s zaxqkl0QFv;8KdnJ1X#v(X7`(cQRmm`FzX%n@uH%Ht66>FN4V=6 zw!qMy!(ai~(>7~{vnttsJi}ln=3X=KmLW`P1E3%?d*XDn(9zBiT~k99(?wR`UI7TD zL+I^x{l#KR+`yTRrkCD9!;s)SzZ*|kF^WasJx*cvHK^9%BbDVz3ScuI zK4{pLbWhq%vjOH+%z$hF?v%`b$pXKS?sUlu0IvGapCsmKM5uEB9Ka3HT#MFDbRP4Y z7@IIftJ3<{po=mV`UMn)R9i%=SPH`FF1*<`Q?z+v>oX_EWTh2fZi{sm-TMGu6?wAY z2~>nl85>eWAmqrY2fUNDJ;i2xy+)=VoIzvygS}?M!hV2%Ux^5ukW-vUj|yZte+oht zWDlpj_zDK4v|IwO=j!)Fpbw#HpPv>3o#qT74Ia#wC_iE-)&j;DpLS`AO~+a2lKBm- z9qpRB5H_W!z%7kZR<`l!XfkvEdI_YYGi_JOCjDYfMJrF&Xo>ktLKyVmkxluLDZ3p^_OBVEVAj59n|o8GfE3&kAI=d=EA;yEKI0V9M7O`$?CZ z2n8%_I)K;9{0HK>56v|&nazhfFj?u0#35_EQj9_3sf-ht<&svZ5w96eY}8(xSQHl4`VGa4@j3 zfmuUEB5r?o`AbOIqrk(WW(JDxd~ce;CAEt=&sbD)Y+5=Q-m8q5eDWRB>2Zf7F`oqv zTN~-_u(_O~zpKdPUjN|%`%$Y(@@+G4F@`-HGdZXJE}!?XU1^(!ABnx@WBmLXWHWQW z3;BVC<*|En*83KB#-_B*_hXwuXc5Eiu%PV&xn%vCXZxmt*zZeP{^z#`Gaf4(c(dQ* z$+d~pIE-q8b@b^^NZM|;JnB{3jX*~GA#B%Qvp+f4px6`IcuNFAmrw)Q(@y&z14+tPvM zP7ab|#p<>zI-w2ps-ntkLnlinGleVo(@4#y3CCe&uX_oNphCsZTh4K`r+VyOc@--9 zN^N5kN3r0BrDC~AKz|_UR`PI>rvjj#NNR~RAPMMe2 zyWVD?|KK;&aLZA+vP(_PC;gTyp>hBil+@nu$UB-1&XbEVl!{n_8|lg=o`y4;y(u&r zXy?57iv%ROp8M=3<^zm<7LLnLnK#+e-|cFXi_Q)qKMstm9NYXTr*nuZx!Dkt`GB2? zQGmXRHrq9~;9c`A$F18)FV}exz$%h9%&=^N@rmwj1y1tEQn%rkV<)1Q1^d4P?{#@< z<9#$mN-sOj*{*B7-!`=m9_wyvSZS+@SiUg63k+ce$X6fO1klp(#_#AI`al!FI&Y#;s$Vm&V- literal 0 HcmV?d00001