Package: sc2xmlreader
AbstractThesc2xmlreaderallows to query the XML data interface of the solvis remote extension of a Solvis Heating system with a
solvis control 2 board. The XML Interface provides a read-only access. Controlling the heating system is not possible.SC2XMLReader returns the data and states of the Solvis Heating device.
The xml-file is public and can be retrieved via http:///sc2_val.xmlWhen querying this interface remote will return something like:<xml>
  <data>
    AA5555AA056B0C31350600120076028A013A018[...]0000000000
  </data>
</xml>the returned payload data has a length of 439 Bytes in an coded format.
At this point, many thanks to all the other persons that have decoded this format in the past and shared their insights.InterfaceTo verify your hostname and user credentials and get the correct url:[...]
   from sc2xmlreader.sc2xmlreader_validator import SC2XMLReaderValidator

   [...]

   try:
       my_sc2_credential_validator = SC2XMLReaderValidate("hostname", "username", "password")
   except ConnectionError as err:
       # my be the hostname / ip is not correct
   except AuthenticationError as err:
       # my be the hostname / ip is not correct

   correct_url = my_sc2_credential_validator.urlTo query data from solvis remote:from sc2xmlreader.sc2xmlreader import SC2XMLReader

    [...]
    
    try:
        my_sc2_reader = SC2XMLReader(correct_url, "username", "password")
        the_solar_power = my_sc2_reader.data["solar_power"]
    except ConnectionError as err:
        # may be the hostname / ip is not correctExceptions generatedAlle kinds of exceptions from "requests" packageConnectionError - hostname wrong or solvis remote does not answer as expectedAuthenticationError - User and/or password incorrectHintBefore being able to use the integration, you have to own a solvis remote device and have it attached, configured and available in your network.
To retrieve the xml interface, a username and password must be provided.Sensor data providedThe following sensors are available in the data:keynameUnitDescriptiontimelast_updateTimestamp of latest data update.Z1runtime_burnerhTotal runtime of the oil burner.Z2total_burner_startTotal number of oil burner starts.Z3total_burner_2nd_startTotal number of 2nd oil burner starts.Z4runtime_solar_pumphTotal output runtime of the solar pump.SLsolar_powerWCurrent solar power from the solar panels.SDtemperature_solar_diff_flow_return°KTemperature difference between solar flow and solar return.S7solar_pressurebarCurrent pressure in the solar pipes.SEsolar_yieldkWhTotal yield of the solar panels to the heating systemS1temperature_buffer_top°Ccurrent temperature in the buffer topS3temperature_buffer_reference°Ccurrent reference temperature in the bufferS4temperature_H_buffer_top°Ccurrent temperature in the heating buffer topS9temperature_H_buffer_bottom°Ccurrent temperature in the heating buffer bottomS2temperature_warm_water_station°Ccurrent temperature warm water stationS11temperature_circulation°Ccurrent temperature warm water circulationS12temperature_heating_circuit_1_flow°Ccurrent flow temperature heating circuit 1S13temperature_heating_circuit_2_flow°Ccurrent flow temperature heating circuit 2S10temperature_outside°Ccurrent temperature out the buildingS5temperature_solar_flow°Ccurrent flow temperature of solar heatingS8temperature_solar_panel°Ccurrent temperature on the solar panel(s)S16temperature_solar_panel2°Ccurrent temperature on the solar2 panel(s) (if east/ west option)S16temperature_oven°Ccurrent temperature on the solar2 panel(s) (if oven option)S6temperature_solar_return°Ccurrent return temperature of solar heatingS17volume_solar_pumpl/hcurrent volume of fluid stream in solar heatingS18volume_warm_waterl/mincurrent volume of fluid stream in warm water stationBCburner_capacitykWcapacity of oil burnerOCburner_power_consumptionkWhPower consumption of oil burner (calculated)Binary statesThe following binary states are available in the data:nameDescriptionA12burneroil/gas burner started.A13burner_s2oil/gas s2 burner startedA5circulation_pumpwarm water circulation pump runningA8heating_circuit_1_mixer_openindicates that the heating circuit 1 increases the flow temperatureA9heating_circuit_1_mixer_closeindicates that the heating circuit 1 decreases the flow temperatureA3heating_circuit_1_pumpheating circuit 1 pump is runningA10heating_circuit_2_mixer_openindicates that the heating circuit 2 increases the flow temperatureA11heating_circuit_2_mixer_closeindicates that the heating circuit 2 decreases the flow temperatureA4heating_circuit_2_pumpheating circuit 2 pump is runningA6heating_circuit_3_pumpheating circuit 3 pump is runningA14recoveryrecovery is activeA1solar_pumpsolar pump is activeA7solar_pump_2second solar pump is activeA2warm_water_station_pumpwarm water station pump is startedTrademarksSolvis is a registered trademark of Solvis GmbH, Braunschweig (www.solvis.de)