From 13cc6b2bd4b8478a7f0b35e09739c9f8a6230489 Mon Sep 17 00:00:00 2001 From: Gido Date: Wed, 19 Dec 2018 13:27:47 +0100 Subject: [PATCH] Documentation for SolarEdge platform (#7735) * Added solaredge platform documentation * Added SolarEdge image Updated documentation * Update image location * Update sensor.solaredge.markdown * Update sensor.solaredge.markdown Add default to monitored_conditions Set Home Assistant release --- source/_components/sensor.solaredge.markdown | 105 +++++++++++++++++++ source/images/supported_brands/solaredge.png | Bin 0 -> 5480 bytes 2 files changed, 105 insertions(+) create mode 100644 source/_components/sensor.solaredge.markdown create mode 100644 source/images/supported_brands/solaredge.png diff --git a/source/_components/sensor.solaredge.markdown b/source/_components/sensor.solaredge.markdown new file mode 100644 index 00000000000..eb06e02f896 --- /dev/null +++ b/source/_components/sensor.solaredge.markdown @@ -0,0 +1,105 @@ +--- +layout: page +title: "SolarEdge Sensor" +description: "Instructions on how to integrate SolarEdge sensor within Home Assistant." +date: 2018-12-04 14:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: solaredge.png +ha_category: Sensor +ha_release: 0.85 +ha_iot_class: "Cloud Polling" +--- + +The `solaredge` platform uses the [SolarEdge Monitoring API](https://www.solaredge.com/sites/default/files/se_monitoring_api.pdf) to allow you to get details from your SolarEdge solar power setup and integrate these in your Home Assistant installation. + +

+The SolarEdge Monitoring API has a daily rate limit of 300 requests. In order to stay under this limit, and alow for some additional requests, the `solaredge` platform will update the site overview every 5 minutes. +

+ +## {% linkable_title Configuration %} + +To use the SolarEdge sensors in your installation, add the following to your configuration.yaml file: + +{% raw %} +```yaml +# Example configuration.yaml entry +sensor: + - platform: solaredge + api_key: API_KEY + site_id: SITE_ID + monitored_conditions: + - current_power + - last_day_data +``` +{% endraw %} + +{% configuration %} +api_key: + description: Your SolarEdge Site API key. + required: true + type: string +site_id: + description: The id of your SolarEdge Site. + required: true + type: string +name: + description: Let you overwrite the name of the device in the frontend. + required: false + default: SolarEdge + type: string +monitored_conditions: + description: SolarEdge Site information to be monitored. The following conditions can be monitored. + required: false + type: list + default: current_power + keys: + life_time_data: + description: Lifetime energy generated at your SolarEdge Site in Wh + last_year_data: + description: Energy generated this year at your SolarEdge Site in Wh + last_month_data: + description: Energy generated this month at your SolarEdge Site in Wh + last_day_data: + description: Energy generated today at your SolarEdge Site in Wh + current_power: + description: Current generated power in W +{% endconfiguration %} + +If no **monitored_conditions** are specified, only **current_power** will be enabled. + +### {% linkable_title Full configuration sample %} + +A full configuration entry would look like the sample below. + +{% raw %} +```yaml +# Example configuration.yaml entry +sensor: + - platform: solaredge + api_key: API_KEY + site_id: SITE_ID + name: SolarEdge + monitored_conditions: + - current_power + - last_day_data + - last_month_data + - last_year_data + - life_time_data +``` +{% endraw %} + +In case you would like to convert the values for example to kWh instead of the default Wh, you can use the [template platform](/components/sensor.template/). + +{% raw %} +```yaml +# Example configuration.yaml entry for template platform +sensors: + platform: template + sensors: + solaredge_last_year_data_template: + value_template: '{{(states.sensor.solaredge_last_year_data.state | float / 1000) | round(2)}}' +``` +{% endraw %} diff --git a/source/images/supported_brands/solaredge.png b/source/images/supported_brands/solaredge.png new file mode 100644 index 0000000000000000000000000000000000000000..ba4584ccf0e19219136aaa488f28a76e1bd5b948 GIT binary patch literal 5480 zcmV-u6_@IXP)003nO0{{R3j78z<0002PP)t-s|NsBm zAt(R<0NNcT;7CsT`uf-a2b`RoL_|dQ&d}Ku9oPU2^25W}006kSxaV_t@wd72^Yf;r zrr8-GJv}|^jgS!$5!nqG(9qCvadGSG>(~br-rnB$*Vul3en&?~7#JAkdVKAipWG}m zu&}T(F){k#;!#miXJ=>p>gzT(HqXz`zP`Tx_4S8`haVpw;8a+Gf`ag`u~=AG-8nwv zXKU`Hr{ZB{larGuC@9}TNb8iBX=!Qo$ja%5isD#Z@v^m9BrPfc02E+JL_t(|ob6qE zL#j>_&VyQF-lD=pOQk4F%JP!wN&Ehv>IDScnVp42DS3aV=f87gVB3eCot+y;M~6b; z#a7*r+`JDy=!NZ#yxk%wBI?@bh^ko>7CldP?a=bT(I{oRZ_X>j?i@N zLi88^05VScQdN~)I?y5M#guNlBNXHGP;;7f(pTlQD9;+{Ic<8VNzFLvZ$^r1yv#)9NC#q}!F0=Q&%XA5yz#m-JM3U{znIc_V3=TD~95#M%%C{REa{!p zwR@IGuN+ppXO;AR+O~U^NLRE&O{4(?o&)N;PoKkfLg zk3s2eHJuo$4CxNzlUl#-1w8FRr*!(Z8s&`5v(#FT!Ga%vW~h08yaU_)y9(ClSO226 zHVvJ-T3aK}O!fK(kPUHi)fP{bgWK!z3oZFEejSn`GNf0p?uA1dzdq4J;cwfTpF>f4 zMDC=odnJqXSq(b%sm{-%4^^vua)%+SRP$($CSBL2B^=?lJN=3GtO~d(4*4p&nxAzB z)Oc;HbYZIKdVR@W(mEFN9pFYdQ|+rb*;nF~i6{N68*|(4F|pjM>=kG3A9u}5o(taL z2p!;HFq;^p+SFHq<8P-{R3b^&%1c_bFjF1tq6kV8AnA%>##AnpdODD(urF6ruu2iG zNG0F6j?fSxJ#%h4<4A9hC5Ci&%gJHV+c%WpOSI+^!CvNgLr*h5g#v|{qC}9cuf?== z@_Mce?hHuRa)Q?d++)fdMzj(0%TQu=J)9E@t9>UYdxPJY7}A@PW13?@K>F=bL-0yI z#+xbhG@6)obrG3=^i~v;u1}-FAA^w&GagvdRa5TBeX-5))MwlOmYrS)=iE#^#i`(} zELvO9q_?HVge3v#)q>C{7)#9=4{HKh*YYuOt64=vx*n6cG{{%p*ncymt9e;}>MU66 zin)C`#nVFI3f-~sC@*^tMI%Ws$mn(-$eshF56{GMyD4~wHQ=0Al-L!Q6OgXNI>I|T zsD0d$t|{_9^gxQ$?ziG;A%Lv8ha|GEKs1u{2(CE1Kv6*YJi=PRFR(N~R=lx{z5Wzj zvL(F|UsSdP?@LI!qKT~t4z{22SKew3YN2<#-H%5XADr?Y1B2`-0XGi7<`79bwGnq+ zP`9lD(JFNbg^wL~^>7xw>6cNnK>vrNYk3Jt@V8d&$dhV9t@RmCuK7bcdn)E--Bs0f?@y{Fm_{$+e(sh~Y zQShgQq*oH9t`9sbgiW77b9Bua=ncp$%MNb>j-St}Pc3Jpg?9D%FJ6~->^2%j`ZF37 z8q)9t{tk9$g7o{>YO_&j5v+ zoIgl?XZ{U*D-Yx>0O!pKv#G<`<(*?k_-xQ+eu*Hx9e-c2=iITsAkyJ0(_kO^LH@Ni znHUL=)K-usjlx!^e6_2AGZB5#l^lE&qE?{Z+d zGBz*dhFXx^;eh=`mUJ?%0$#)y*1ANbBWczT|3U`pEV4{lF@d)ANyo*23nCb=qeOF` zbZyORVEjx2?ae;vFmAFWvp!(f>ze_60>Ib;n`4OfHG}8v1jAJI~dR{X{xsjMXU}fwNV7(jjwn%_Och^e-y28-x8$W_>6MJF=3h z1APxjCpD=MFf=EKZ@2yk9uP(P-ARb^douFX0vd{a;UMYQ2xQ;EE@{CCN>|n)0jn_ zQi?3ggM|s`0fwCTGz_C?@Kym zjODP&T-vC2sPhMO<)a2YwLa-4II#%~2@nAfNQbYVC8*7S+XwO&KtD*5rQQHXe4#l2 zc7DcVdU(<=Nzx|*(nsuiEp5~>40nIhd9JL}`)EsgWFk}`3XMRYbg*hIL5(eZAK^mB z9?$Vvvr&jn8VVrZRsn$dKHicbOM1aUqfyu({9j4ZFEQ!E^P2!C_oVec(NzitAicA3 z#FoJV`VuTUjUs&l?0(t=cg!&`v<>NSPw7<1;i?tbkQU9tA0Ch6tLy9enS4tDp+NPoIL{>$t?-TSNC;b!i4B|RQ>0RX>#hms=Lm}jExl_VXkEKw~L zNjji&@I?>zD=K|XB5&s9^s$t?@BP>@`{a`Y2h1Y?Q%GUZgHA#}!Z8k6(xY>-ud_lrSi>UHiv;N!?A4iw zbYPe7hL%JIGda88Nji?nVjLfsbbCaQPCMlA&QFpqDwTx~NRRXcsU~oGCBh=y?eFAB zj~~)d=p^_*Asq(df1LCfRf@1B_xnh1$LCddh3@13OVWkv{o6=Sl;61Zv40=wv1L*i zKTdjKO&D_DLHalC=^k$7QyfDt%(w07T&|{vJ1;+%uBSpR=a)szzs7^(#=X)0vnQwQb)G5t#@!_`-~lK zB|1sF(S90MZ*R|h%&*4O!U}l%u5)?;X`MMoTniibX_B6#8!%kMNzUnr^hC~?8GpM7 zfaEwS6bkJ#TwxTUk=XN(BKjV#6j~9CaFqDI^3@XcZC@odyzhad#)(7t(1#f z_|`jIbb_AYg3KB4P(ivBO1$(*pR!8A61}6UH_!@M(|mok#a~fLADv|m==>`Xg^BMn zIdafJD7bASJvVF~mJIgNaz?ZXNeD^?PvKw|(C9M=Q~023J&Ho;6Q!KMzY zVwr%vq#-9zAT42KPD0WPBMokngFLA(VPTn{E`_QQY$~Zzg@*${g$tR~T1H;>puz?4 zS*H)`<)}_LKuwBLpuw6BU8(RuO|_oFhk2=5HmN{PYDYG=FDSI6`_wEd3fLTjJy?hO z_l-B@xSlkDdPhg89>1&T=yeHKIxKP~nw-V?;lRc$>aGTiv27YNn0UH}3v}n5GrveW zX9PtQ@VtYh-N(vF{ydZn`1?Wm)V_y6yVH(9*GcZZ}`1 zuZ*IXQJHz*d_yjD=N;0Fu+Bx%bYsC;&tZK!qQ$oMV1lnqPS?@up+OSm}v^^j?{+Zu97PwbIU9A$$6mlysVS-^3)-AOOGx{>>$_+U1j z55OCx#m|E0)c5pYWarrvt8V zy|m0vwBjb-<_N#{W4a$fXX>9n_h+rJw7@Gf;ChG@gt890C-)D39~|7@@DaKjmICR} z>gCn2)!GiJ(ZVff_91-}1J^jWl|2{?tdf^OZV?@KL$iy>M=oq6Pbs-0rsoXNm&$o+ z=d@n`9MGa+N4Pa5>4`eRg69GdX)5RA&|P!FB{Z;Jm_&(I$Wr#i#! zPWncn60;bIZ7oY|zepD)P%ECOyA%;x&BdI@WRRdss5gy3MSsK#Yytf@5$RGg?IP3h zy_bA*yO_vB%{Bs%$U+~CNYWKE{z(J6c_3+E{3B}fQqIQ!onvcDDg=d<-Yhqe;)H`&PNg_ul=(pX6WTMFJpqUsMWod;!Ka z*!XuPee3;H^YUwF0Fs+j{J8{-P6e3wOmEm&1z)ew9V5B+7Rixdxjx{jDM%N{U>9#> zu|r&~)nx-bcURJx-oD0EcCFj*@LX*4B3ZW<&?m>Fx@eQ=X2PGS^DINUl9RCrq9DyW z6*QML<~T2HBqv%9GQ0GrPUAyi%7@$L$jK-o*>WR0t`?;71 z(w(lI1qST5)nw?=Y*@?$mo~ z(YsvjS)DEL=h-!*vYxS@da|w0x2an8L?cOe?p!X9mZu#;SvWV5)B}x%TTaj%R(%Y; z3WJ7Z?s&nGb`$5%j_32^v+D4v?K;w;p2k3Mojamob$ILC(z&VYnTwS!fM22pY?EKC zQw=p|F7oSXEx>d=$}c9)50Tk(imscJ(X_U@Sgv~0k=M^T_|0TNeOyhMI1lWtE-rf0 zb$+6R{`(lxU0Gdq9=m>@)_SX@i;Iwgo6*6z4w ziS)Kjq`FrTf{AiM{v9N#Nd6wcBH|K%YExmRL_z+z!Drh3;wWs`en`OJ+fjXD1ioJH zn|iuBg#muSHv}l)ocdpQn91*t-vyj)KUn6?jh8-Wnv>BAed{y9h6L@uU-%GwW9MhV zeW%qiFE=&iROY&(3cq8*M zsXMA%LHsWQluYB`2lbq5bID|{4_5TI9l5({hACaM@h`&aJE!8qLn%(<7Q5Xy