From 8d03830e78ec4623d90d7697858cc7d60ffd09f1 Mon Sep 17 00:00:00 2001 From: Ernst Klamer Date: Wed, 23 Oct 2019 20:55:33 +0200 Subject: [PATCH] Add Solar-Log integration docs (#10473) * Add Solar-Log docs * fix suggested changes * Remove of scan interval configuration option * :pencil2: Tweak * :pencil2: Tweak * :pencil2: Tweak * Update due to component changes Added the option to use configuration in the user interface. Removed the requirement to not have http:// in the host address (will be automatically added now if not provided). * :pencil2: Tweaks Co-authored-by: Klaas Schoute Co-authored-by: Franck Nijhof --- source/_components/solarlog.markdown | 103 +++++++++++++++++++ source/images/supported_brands/solar-log.png | Bin 0 -> 3555 bytes 2 files changed, 103 insertions(+) create mode 100644 source/_components/solarlog.markdown create mode 100644 source/images/supported_brands/solar-log.png diff --git a/source/_components/solarlog.markdown b/source/_components/solarlog.markdown new file mode 100644 index 00000000000..c8c21bf73c0 --- /dev/null +++ b/source/_components/solarlog.markdown @@ -0,0 +1,103 @@ +--- +title: "Solar-Log Sensor" +description: "Instructions on how to integrate Solar-Log sensors within Home Assistant." +logo: solar-log.png +ha_category: Sensor +ha_release: 0.101 +ha_iot_class: Local Polling +--- + +The `solarlog` integration uses the open JSON interface on Solar-Log PV monitoring systems to allow you to get details from your Solar-Log device and integrate these into your Home Assistant installation. + +Before being able to use the integration, you have to activate the open JSON interface on your Solar-Log device. This can be activated from the Configuration | System | Access control menu of your Solar-Log device. +When activating the interface, a red warning triangle with security information and risks is displayed. + +The `solarlog` integration uses the default host address "http://solar-log" if you don't specify a host. If your device isn't accessible on this address, use its IP Address instead. + +
+The open JSON interface is deactivated by default. To activate the open JSON interface, a user password must first be set. The password isn't needed for accessing the open JSON interface. +
+ +## Configuration + +There are 2 options in configuring the `solarlog` integration: + +- Via the Home Assistant user interface where it will let you enter the name and host to connect to your Solar-Log device. +- Via the Home Assistant `configuration.yaml` file. + +```yaml +# Example configuration.yaml entry +sensor: + platform: solarlog +``` + +{% configuration %} +host: + description: The IP Address or host address of your Solar-Log device. + required: false + default: http://solar-log + type: string +name: + description: Let you overwrite the name of the device in the frontend. + required: false + default: solarlog + type: string +{% endconfiguration %} + +### Full configuration sample + +A full configuration entry would look like the sample below. + +```yaml +# Example configuration.yaml entry +sensor: + - platform: solarlog + name: solarlog + host: 192.168.1.123 +``` + +In case you would like to convert the values, for example, to Wh instead of the default kWh, you can use the [template platform](/integrations/template/). + +{% raw %} +```yaml +# Example configuration.yaml entry for sensor template platform +sensor: + - platform: template + sensors: + solarlog_yield_day_template: + value_template: "{{ (states('sensor.solarlog_yield_day') | float * 1000) | round(0) }}" +``` +{% endraw %} + +## Sensors + +The following sensors are available in the library: + +| name | Unit | Description | +|-----------------------|--------|:-------------------------------------------| +| last_update | | Time of latest data update. | +| power_ac | W | Total output PAC from all of the inverters and meters in inverter mode. | +| power_dc | W | Total output PAC from all of the inverters. | +| voltage_ac | V | Average voltage AC from the inverter. | +| voltage_dc | V | Average voltage DC from the inverter | +| yield_day | kWh | Total yield for the day from all of the inverters | +| yield_yesterday | kWh | Total yield for the previous day from all of the inverters. | +| yield_month | kWh | Total yield for the month from all of the inverters. | +| yield_year | kWh | Total yield for the year from all of the inverters. | +| yield_total | kWh | Total yield from all of the inverters. | +| consumption_ac | kWh | Current total consumption AC from all of the consumption meters. | +| consumption_day | kWh | Total consumption for the day from all of the consumption meters. | +| consumption_yesterday | kWh | Total consumption for the previous day from all of the consumption meters. | +| consumption_month | kWh | Total consumption for the month from all of the consumption meters. | +| consumption_year | kWh | Total consumption for the year from all of the consumption meters. | +| consumption_total | kWh | Accumulated total consumption from all consumption meters. | +| total_power | Wp | Installed generator power. | +| alternator_loss | W | Altenator loss (equals to power_dc - power_ac) | +| capacity | % | Capacity (equals to power_dc / total power) | +| efficiency | % W/Wp | Efficiency (equals to power_ac / power_dc | +| power_available | W | Available power (equals to power_ac - consumption_ac) | +| usage | | Usage (equals to consumption_ac / power_ac) | + +
+The solarlog integration is using the sunwatcher pypi package to get the data from your Solar-Log device. The last five sensors are not reported by your Solar-Log device directly, but are computed by the sunwatcher package. +
diff --git a/source/images/supported_brands/solar-log.png b/source/images/supported_brands/solar-log.png new file mode 100644 index 0000000000000000000000000000000000000000..ed9a360ba749a319a98fed0e27664b7095d3e179 GIT binary patch literal 3555 zcmV<94IJ``P)#wN4p$ehDqy8~hj!NM}7Qsg>U}R)uWX=HfKJz~RBMVU(!U}33 zumFJtTd?W|)2&@QU#ZkWOS_mv3LB&zg+?VwU{_e#Fv_3`sn`I~( zZIO|YwP1CDg$Sz(1%rU~0V@z%5yHwhy$1x9kBU%*09LIMwQW`LhA)3TMscb&GO}H0 zm)>Iu3g)m<2Ud!(au%L|zzPslseo1m|Jgo8L}2BpkZO;NY&VUp-eqYGs{z1D5mx?K z_lL0Z5mqUDhT!^)g$-bNsEVLPMz)J!g#txj6`#MqzJO1J6-O2D-)+#Ep@5)8Mz+&o zm9w~pl_Id>soXaLD@O6w)R3S>Mz&M!(mO0fV1WX#DumUfx6vS|d;zRlwB?74Y=^-r zKvfFBDiBy#MMwdHDiy#gYu^^tG8x%U0oHF=fxv!&Et8S$ z3|Pe|=mA!Nau2J`vmV<#m!m+a!heelpp`eEs%xdrm2IQ59Z<=8Gmay>Yk3jT`u2rTFU)_7BeLvL~vNR%5is;oJZu+&hafv}ns zw8SHt=Wz#2Cc;NWW<1rp^J0aF+jdL{u;x{Ub}E0nS1b1?ynfVE4@tL_(E z^p#ZnJyiA;f&w;EQW`8|ASBW(n*&PR7s2x28*5wIo*ta3T~X@rVw z0jrV%D`)FzxcB{pqd+24U}ZL@g_4dQD*RqBB_I&62v`#Y)=Y%gEMM^RsUo}dOU7$h ztpXORbbhyW1p7kUr)BpZ=O~aUchEsSOW!lQN*fFTi-0vHVDUz~Oqc&&11s(TmOJ0o zkux6KJX@fkp>*s2?|z=6K%#sK9aIv(l#Eo#f$)jNE%9{%OWaqu;=X3O(_i5$Tt4e; z#sB-_``gzH$K32b1zQjlojPrBo2jsl5X04vq}u2r41 zu-!o#bNZoiUXe>+322uZ_m!A{KoL}6J4kqH!0HH>ak4#3vmI8}R>KikAOTkBw4@Kd z4pP;2+xIvMBys^P-R(YMM@1E4NNY4C@41GGQWwAy_f;9(m(nV!;j@qCmm3>cilZuP zJ1sP}pII3cr~=D(3M_ey)dESt{&- zXKVvl!e>%-4F8jX_mvs~Yw0VQwXT~i<9T+H532_rxhU^uIrRBG1A~{-s&*Ll^oPhc zu-rQf?@d4|v}^g}90d~D4jeTCRs&j@<&j0Hvz@2M&){1CmJB{g*E5O6Tn?SCDLB-9 zHUS$0Sgk~qZD?~%&=o!Hy3_%W09PfsSI;J}V&}Ch4_TOl8L-;^)52*>TI!1lb0I(NBI=54w$khj|R04oN@%KXu+sTG5%2d|Ef7S-9 zJDvfl(7YQT;V6(OckqS+2aRhPACwODAxJuPJn;H66<^LkV5O#cpE@#J1OtFIx!nA& zfz`2hl@I)$M70hjqpP9qFtX-TlmN?oHD&Xh$2QN0?CAM;{%8Gj)8s3Fb8zh4_b^9+ zL?*zJ&BtA@=*ZqQrDDUZG^6qJz6L%JSfz~=ITG+i1ArB>iP;Fin%THU@YT;CuIn7@~O1z{)L# z;&7X;f-!*=TL+drEzDK{f9WgV0GS*DD_vI<^pJ*4BP{2@%4mdj^^UMsrI#^tXx{ZK zNVW9o3bormH72mSBHImp zFoQNVckJ&g2M(iER;xnCdkHh0P2HkStD*Huz*1_@RhL7&k-c*YdkM`~<`GzFE4>W2 zSaDa(lg9(rvA&oaU8iNPn602MQ^8DQ>a^UNlGxZKF9BB6u~kMTTf=NX8SGSG6|MRi zEFFLBitGtV4>)rTGUdMDT z_8v;16&f~B6KJIauCtDeqbeh_nFVMQurxdN8ZwSXQv;S?C+}+-z*6=T$wqCu zr=9EObWd+^vAd*>!D;|YH%QE1(YdxwEhM9p!JoMjR*!iItO^A+usWc{EjLz`Q)4p2 zEjB|=%}EBFn&b8Oq6_?>>69rc82v}U9zoiNwDQz4EF|ZxR;`7`I zumrRU0j%nB&P>jd3mfOdd3~Sh_#Ww*bWOYN=5Ghr-TbX$u_y6S=zvz@u+gqMmrwgl zzJb??4EB2YE6$dShlYGe&IpV;9LS+c-8MeQ*+i|?R&9w7yoXii1R9;s*i}az?J!XA zd0GP2J1h{eg3IrYkj&45?b-iCa4mnlLTCX(3zpDYB>dY3trDT-F)}hT6O=aVtV99jZ?$jQEl_IRR zkFt)wJ!41DPs4|B+jl*7>vxhx;=iZFi8`Io3aJT_kqrV(p?jWW<2$0!5)L4&=FqzI z9t#@KO4;W5jBTFt*H)6Zf4@FxwM1wELJJh2MX(|x8xE{lM|@tO@cYT=2{UVGA+WZ` zWzC^=u0q9Z^Xzz2#yg+k?2aGg?DnStp(V0F^g@eZMMkC%t*qya&31}!zbD$gy1{ii zCj?dvt)vC5`fv$AU{&nMnFQr-#C7-coZar--2CkwW5B4rP~6|qBaa&{<{L+pW912%hwv-@9; z+5InN?7$1vBCT?L8uW2MXu$wzWe6<_T_7W~53NKKR)t9{m>b(X7m4X%6Iy`40t6N+ zU7Vit;2R4ad>!=~u&@3M*aJUZ98xiR1rS=OmjIy!1EEzRv}g)QM&=e=d_Z3Oa*Ah2 zHlgJqw9=8GRUx!ugcgme$jHVWafM>k)y#jNcBLnpD7eo0b4UE))0IPLRS2yZp+%q~ zBO|k93nzSL30f6GD@AC{s9?#+$lTh-369W;5n35SEB^voKbJu(M`)$&z>5*P?*&@* dBO}|z_J1+uAs6K*6x9F#002ovPDHLkV1k^feYyYu literal 0 HcmV?d00001