Difference between revisions of "SMA Webbox example"
From PhotoVoltaic Logger new generation
(Created page with "== Abstract == This is a special model to split [http://files.sma.de/dl/2585/SWebBoxRPC-BA-en-14.pdf SMA Webbox RPC] content into single channel values. This model is in con...") |
m |
||
(14 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | + | [[Category:API]]{{TOCright}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
The SMA Webbox model handles JSON outputs from Webbox RPC requests. | The SMA Webbox model handles JSON outputs from Webbox RPC requests. | ||
− | It scans the data and search its '''direct''' child channels for matching [[ | + | It scans the data and search its '''direct''' child channels for matching "[[Channel attributes#Channel|channel]]" definitions! |
== Setup == | == Setup == | ||
Line 22: | Line 15: | ||
'''''Please note:''''' | '''''Please note:''''' | ||
− | * The '''[[serial | + | * The '''[[Channel attributes#serial|serial number]]''' is used from external upload script to ask the SMA Webbox for the correct equipment. |
* When the serial number '''changes''' after firmware updates, '''don't forget''' to update the serial number here! | * When the serial number '''changes''' after firmware updates, '''don't forget''' to update the serial number here! | ||
− | Special use for this channel type is the [[factor | + | Special use for this channel type is the [[Channel attributes#factor|factor]] channel attribute, named here as "Installed power". By default, the factor is only used for reading data. |
But as you know, the SMA inverter is a not readable group. That is correct, ''but'' the attributes are always readable... | But as you know, the SMA inverter is a not readable group. That is correct, ''but'' the attributes are always readable... | ||
− | In this case, the factor | + | In this case, the factor must held the installed power in kilo watt peak on this inverter. |
− | So it is for example possible to calculate the relative yield of the inverter (watt or watt hours per watt peak) by using proper channels and this factor. | + | So it is for example possible to calculate the relative yield of the inverter (watt or watt hours per watt peak) by using proper channels and this factor. (This is done for example by the Twitter update script) |
− | (This is done for example by the Twitter update script) | ||
=== Channel tree === | === Channel tree === | ||
Line 44: | Line 36: | ||
Define the inverter channels according to your inverter. (If you created from template, this is still done.) | Define the inverter channels according to your inverter. (If you created from template, this is still done.) | ||
− | Check for each real child channel the correct [[channel attribute]] entry! ([[Channels for SMA STP inverter series]]) | + | Check for each real child channel the correct [[Channel attributes#channel|channel attribute]] entry! ([[Channels for SMA STP inverter series]]) |
'''''Please note:''''' | '''''Please note:''''' | ||
* Use the exact channel name as your inverter delivers. This is needed to find the correct channel to store readings for! | * Use the exact channel name as your inverter delivers. This is needed to find the correct channel to store readings for! | ||
+ | * Here the [[Channel attributes#factor|factor]] is set to 1000 to get data out in watt hours, the data delivered from Webbox and stored into database are in kilo watt hours. | ||
+ | |||
+ | [[File:E-TotalChannel.png]] | ||
Insert all the channels as sub channels of the inverter in the channel tree. | Insert all the channels as sub channels of the inverter in the channel tree. | ||
+ | |||
+ | '''''Please note''''': Only sub channels on '''1<sup>st</sup> level''' will be scanned to detect channels for data storage, not on deeper levels! | ||
[[File:SMAInverterTree.png]] | [[File:SMAInverterTree.png]] | ||
− | A special case here is the [[Inverter efficiency]]. | + | A special case here is the [[Inverter efficiency|Performance Ratio]]. |
− | [[Category: | + | [[Category:SMA]] |
+ | [[Category:Example]] |
Latest revision as of 16:31, 28 September 2014
The SMA Webbox model handles JSON outputs from Webbox RPC requests.
It scans the data and search its direct child channels for matching "channel" definitions!
Setup
Create
- a grouping channel for the Inverter of channel type SMA Inverter or
- complete channel hierarchy from predefined template SMA Inverter
Attributes
Please note:
- The serial number is used from external upload script to ask the SMA Webbox for the correct equipment.
- When the serial number changes after firmware updates, don't forget to update the serial number here!
Special use for this channel type is the factor channel attribute, named here as "Installed power". By default, the factor is only used for reading data.
But as you know, the SMA inverter is a not readable group. That is correct, but the attributes are always readable...
In this case, the factor must held the installed power in kilo watt peak on this inverter.
So it is for example possible to calculate the relative yield of the inverter (watt or watt hours per watt peak) by using proper channels and this factor. (This is done for example by the Twitter update script)
Channel tree
Insert the inverter into the channel tree
If you have more than 1 inverter, it could make sense for a better overview to group them, e.g. by building or location.
Inverter channels
Define the inverter channels according to your inverter. (If you created from template, this is still done.)
Check for each real child channel the correct channel attribute entry! (Channels for SMA STP inverter series)
Please note:
- Use the exact channel name as your inverter delivers. This is needed to find the correct channel to store readings for!
- Here the factor is set to 1000 to get data out in watt hours, the data delivered from Webbox and stored into database are in kilo watt hours.
Insert all the channels as sub channels of the inverter in the channel tree.
Please note: Only sub channels on 1st level will be scanned to detect channels for data storage, not on deeper levels!
A special case here is the Performance Ratio.