SourceAnalytix

This adapter uses the service Sentry.io to automatically report exceptions and code errors and new device schemas to me as the developer. More details see below!

Detailed analysis of your Energy, gas and liquid consumptions Any source (kWh, Wh, Watt, l/h or m3) can be used for data analyses:

Features

Basic features

All state locations are grouped by state name and separated in period and Category structures.
Calculations will be automatically handled and values transformed to the proper unit as defined in Price-Definitions.

If you have any issues, please read the Troubleshooting first!

How-To

State-Activation

Basic configuration (adapter instance)

cumulativeReading

ToDo : Describe logic

consumptionCalculation

ToDo : Describe logic

costCalculation

ToDo : Describe logic

valueTransformation

ToDo : Document link to library (document lib also !)
ToDo : Document watt to kWh transformation
ToDo : Document unit transformation (like Watt, to Wh to KWh)

Year-Statistics

Store statistic information of consumption/prices and/or costs/earnings at the Year level
> >device.>thisYear<.>category<.>selected period

This information is typically used for data storage and historical comparisons.
States are grouped by specified period (like year 2020 vs 2021, ore february 2019 vs february ect)

>#### Weeks
>Device<.>Year<.>costs/earnings
> consumption/delivery<.weeks.weekNr< >#### Months
>Device<.>Year<.>costs/earnings
> consumption/delivery<.months.Month< >#### Quarters
>Device<.>Year<.>costs/earnings
> consumption/delivery<.quarters.Qx<

Current-Period

Store statistic information of the current Year at level : >device.>currentYear<.>selected period

>#### Weeks
>Device<.>Year<.>costs/earnings
> consumption/delivery<.weeks.weekNr< >#### Months
>Device<.>Year<.>costs/earnings
> consumption/delivery<.months.Month< >#### Quarters
>Device<.>Year<.>costs/earnings > consumption/delivery<.quarters.Qx<

This information is typically used for daily/weekly/monthly calculation of
costs/earnings and/or consumption/delivery grouped by specified period

>ToDo : Add screenshots<

Categories

Troubleshooting

Before we start troubleshooting, it's important to understand how source analytix initialises as here errors may occur, see issue section. The following sequence will be handled :

1. Start SourceAnalytix
2. List all states activated for SourceAnalytix
3. Initiate states, for each state :
   • Read current cumulatedReading
     (if present) and memory values from state
   • Check if unit can be handled {Issue 1}
   • Check if cost type is chosen {Issue 2}
   • Verify if valid price definition is present for cost type {Issue 3}
   • Check if previous init value > current cumulated value {Issue 4}
   • Check if valid known of previous device reset > current cumulated value {Issue 5}
   • Store all data to memory
4. Initialise states for each state :
   • create state cumulativeReading (to store results of calculation, can also be used for W to kWh only) {Issue 6}
   • create states as chosen in state configuration {Issue 7}
   • start calculation
5. On state change/update
   • Verify if information is correct
   • transform value to proper unit (unit of state to unit chosen in state configuration)
   • check if value input is correct ( current value > previousInit value) {See 7 At device reset Issue 8}
   • calculate {Issue 9}
     • For Watt : calculate Watt to kWh ,calculate cumulatedReading = currentReading + cumulatedReading
     • For other : calculate cumulatedReading = currentReading + previousDeviceReset (if present)
6. At night (00.00)
   • List all SourceAnalytix enabled states
   • Reset start (Day/Week/Year/Month) values
7. At device reset
   • Store current value as previousDeviceReset and previousInit value
     If the device wil be reset again (detected by previousInit value),
     currentReading + previousDeviceReset is stored as to previousDeviceReset.

Issue 1 No unit defined for ....., cannot execute calculations
Please select correct unit in state settings

Issue 2 No cost type defined for ....., please Select Type of calculation at state setting
Please selected wanted cost-type for to understand what amount should be used to handle calculations

Issue 3 Selected Type ... does not exist in Price Definitions
Now Price definitions are found for the chosen cost type, please verify your price setting (adapte config)

Issue 4 Check settings for ..... ! Known init value : ..... > known cumulative value ..... cannot proceed
The known init value > known cumulated values, this can be solved by removing or modifying these objects in the state raw object "valueAtDeviceInit": xxxx

Issue 5 Check settings for ..... ! Known valueAtDeviceReset : ..... > known cumulative value ..... cannot procee
The known init value > known cumulated values, this can be solved
removing or modifying these objects in the state raw object valueAtDeviceReset": xxxx

Issue 6 State for cumulativeReading is not created
Initialisation of state did fail, see issue 1 to 5

Issue 7 States for costs readings ae not created
Type of calculation is not enabled in state settings

Price-Definitions

Issue 8 current value < previousInit
A device reset is detected, see function 7

Issue 9 My calculations are incorrect

cumulativeReading-Reset

1. Verify if the correct unit is chosen (of not selected, SA will try to autodetect)

2. Verify if the cumulatedReading reflects the correct total value of your value reading, if not
   

   • Stop SA
   • Go to tab objects
   • Enter expert mode
   • Change the cumulatedReading
   • Exit expert mode
   • Ensure the start values are set correctly
   • Start SA
     

3. Ensure the start values are set correctly
   SA handles calculations by cumulatedReading - known cumulatedReading at period start. These start values are defined at the state settings and should be < than currentReading
   Please ensure cumulativeReading >= DayStart >= WeekStart >= MonthStart >= QuarterStart >= YearStart

4. Verify these values in state raw object : valueAtDeviceReset": xxx "valueAtDeviceInit": xxx

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.