diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 00000000..9ed18063 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 7512a1504f4556ca9394a3ec64855f32 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/configuration.doctree b/.doctrees/configuration.doctree new file mode 100644 index 00000000..40ee4a14 Binary files /dev/null and b/.doctrees/configuration.doctree differ diff --git a/.doctrees/contribute/bugs.doctree b/.doctrees/contribute/bugs.doctree new file mode 100644 index 00000000..487e485d Binary files /dev/null and b/.doctrees/contribute/bugs.doctree differ diff --git a/.doctrees/contribute/devcontainer.doctree b/.doctrees/contribute/devcontainer.doctree new file mode 100644 index 00000000..a02c56ac Binary files /dev/null and b/.doctrees/contribute/devcontainer.doctree differ diff --git a/.doctrees/contribute/devcycle.doctree b/.doctrees/contribute/devcycle.doctree new file mode 100644 index 00000000..fdf8ed42 Binary files /dev/null and b/.doctrees/contribute/devcycle.doctree differ diff --git a/.doctrees/contribute/docs.doctree b/.doctrees/contribute/docs.doctree new file mode 100644 index 00000000..af8f13f0 Binary files /dev/null and b/.doctrees/contribute/docs.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 00000000..21378bfb Binary files /dev/null and b/.doctrees/environment.pickle differ diff --git a/.doctrees/examples/foxess.doctree b/.doctrees/examples/foxess.doctree new file mode 100644 index 00000000..fe34d935 Binary files /dev/null and b/.doctrees/examples/foxess.doctree differ diff --git a/.doctrees/examples/goodwe.doctree b/.doctrees/examples/goodwe.doctree new file mode 100644 index 00000000..2daf537d Binary files /dev/null and b/.doctrees/examples/goodwe.doctree differ diff --git a/.doctrees/examples/huawei.doctree b/.doctrees/examples/huawei.doctree new file mode 100644 index 00000000..503813ba Binary files /dev/null and b/.doctrees/examples/huawei.doctree differ diff --git a/.doctrees/examples/lux.doctree b/.doctrees/examples/lux.doctree new file mode 100644 index 00000000..02c2b3f6 Binary files /dev/null and b/.doctrees/examples/lux.doctree differ diff --git a/.doctrees/examples/solax.doctree b/.doctrees/examples/solax.doctree new file mode 100644 index 00000000..7d1ebb9b Binary files /dev/null and b/.doctrees/examples/solax.doctree differ diff --git a/.doctrees/examples/solis.doctree b/.doctrees/examples/solis.doctree new file mode 100644 index 00000000..dacee603 Binary files /dev/null and b/.doctrees/examples/solis.doctree differ diff --git a/.doctrees/examples/sunsynk.doctree b/.doctrees/examples/sunsynk.doctree new file mode 100644 index 00000000..ae1e2931 Binary files /dev/null and b/.doctrees/examples/sunsynk.doctree differ diff --git a/.doctrees/examples/victron.doctree b/.doctrees/examples/victron.doctree new file mode 100644 index 00000000..864e7603 Binary files /dev/null and b/.doctrees/examples/victron.doctree differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 00000000..6084449e Binary files /dev/null and b/.doctrees/index.doctree differ diff --git a/.doctrees/toc.doctree b/.doctrees/toc.doctree new file mode 100644 index 00000000..a7b9edf0 Binary files /dev/null and b/.doctrees/toc.doctree differ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/_sources/configuration.md.txt b/_sources/configuration.md.txt new file mode 100644 index 00000000..2ded1c9b --- /dev/null +++ b/_sources/configuration.md.txt @@ -0,0 +1,286 @@ +--- +myst: + enable_extensions: [ "colon_fence" ] +--- + +# Configuration + +The card can be configured through the following attributes: + +| Attribute | Requirement | Default | Description | +|-----------------|--------------|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| type: | **Required** | `custom:sunsynk-power-flow-card` | The custom card | +| cardstyle: | **Required** | `lite` | Selects the card layout that is used `compact`, `lite` or `full` | +| panel_mode: | Optional | `false` | Toggles panel mode setting card height to `100%`. For use with Panel(1 card) view types or grid layouts | +| large_font: | Optional | `false` | Increases font size of sensor data | +| title: | Optional | | Set the card title i.e. Inverter One | +| title_colour: | Optional | | Sets the colour of the card title. (`red`, `green`, `blue` etc) | +| title_size: | Optional | `32px` | Set the font size for the card title i.e. `16px`, `24px` | +| show_solar: | Optional | `true` | Toggle display of solar information | +| show_battery: | Optional | `true` | Toggle display of battery information | +| show_grid: | Optional | `true` | Toggle display of grid information | +| card_height: | Optional | `396px` | Only used when `panel_mode: false`. Sets the card height in pixels. Specify the value i.e. `400px` or provide a sensor i.e. `input.numer_height` | +| card_width: | Optional | `100%` | Only used when `panel_mode: true`. Sets the card width in pixels or percentage `400px` or `80%`. For adjustments when using the Panel(1 card) view types or grid layouts | +| decimal_places: | Optional | `2` | Sets the number of decimal places to display when using the `auto_scale` option. | +| dynamic_line_width: | Optional | `false` | Adjusts the width of the lines and animated dot based on the ratio of current power to `max_power` (defined in each section below). Requires `max_power` to be explicitly defined | +| max_line_width: | Optional | `4` | Sets the maximum line width when `dynamic_line_width: true`. If you prefer thick lines set a larger value. Reduce this value for a more subtle scaling affect. Values greater the `8` are ignored | +| min_line_width: | Optional | `1` | Sets the minimum or default line width on the card. Values greater the `8` are ignored | +| inverter: | Optional | See optional [Inverter](#inverter) attributes below | List of inverter attributes. | +| battery: | Optional | See required [Battery](#battery) attributes below | List of battery attributes. Required if `show_battery: true` | +| solar: | Optional | See optional [Solar](#solar) attributes below | List of solar attributes. | +| load: | Optional | See optional [Load](#load) attributes below | List of load attributes. | +| grid: | Optional | See optional [Grid](#grid) attributes below | List of grid attributes. | +| entities: | **Required** | See required [Entities](#entities) attributes below | List of sensor entities. | + +### Inverter + +| Attribute | Requirement | Default | Description | +|--------------|-------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| modern: | Optional | `true` | Display the inverter using the modern image. Set to `false` to display an image of the inverter based on the `model` attribute below. | +| colour: | Optional | `grey` | Sets the colour of the inverter and data. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc) | +| autarky: | Optional | `power` | Display autarky and ratio as a percentage using either realtime power or daily energy values. Set to `no` to hide (`energy/power/no`).
Autarky is the percentage of self sufficiency through Home Production. Ratio is the percentage of produced electricity used by the home.
It is calculated based on the formula below and borrowed from the [Power Distribution Card](https://github.com/JonahKr/power-distribution-card)
| +| model: | Optional | `sunsynk` | Selects which inverter image and status codes to use. Options are `lux`, `solis`, `goodwe`, `goodwe_gridmode`, `foxess`, `solax`, `sunsynk`, `victron`, `fronius`, `solaredge`, `growatt`, `sofar`, `ces-battery-box`, `deye`, `azzurro`, `powmr` and `huawei`. | +| auto_scale: | Optional | `true` | If set to `true` the card will use the entities `unit_of_measurement` attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the `decimal_places` card attribute apart from the daily energy values which are rounded to 1 decimal place | +| three_phase: | Optional | `false` | If set to `true` additional 3 phase sensors will be displayed. Requires entity attributes to be defined i.e. `inverter_current_L2`, `inverter_current_L3`, `inverter_voltage_L2`, `inverter_voltage_L3` , `grid_ct_power_L2`, `grid_ct_power_L3`, `load_power_L1`, `load_power_L2`, `load_power_L3` + +### Battery + +To display battery power and current as absolute values set `show_absolute: true`. This is set to false by default and +will return your sensor value. The animated dot will change direction depending on the charging or discharging state. +The `invert_power` attribute can be used to reverse direction if needed by your sensor. + +| Attribute | Requirement | Default | Description | +|------------------|--------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| energy: | **Required** | `0` | Total battery energy in Wh (e.g. 3 x 5.32kWh = 15960). If set to `0` the remaining battery runtime will be hidden. Numeric value or sensor i.e. `sensor.sunsynk_battery_energy` | +| shutdown_soc: | **Required** | `20` | The battery shutdown percentage used to calculate remaining runtime. Numeric value or sensor i.e. `sensor.sunsynk_battery_capacity_shutdown` | +| shutdown_soc_offgrid: | Optional | | Only applies for Goodwe and Huawei inverters. The offgrid battery shutdown percentage used to calculate remaining runtime. Numeric value or sensor i.e. `sensor.offgrid_battery_capacity_shutdown` | +| invert_power: | Optional | `false` | Set to `true` if your sensor provides a positive number for battery charge and negative number for battery discharge | +| colour: | Optional | `pink` | Sets the colour of all the battery card objects. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc) | +| charge_colour: | Optional | | Sets the colour of all the battery card objects when charging. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc) | +| dynamic_colour: | Optional | `true` | The battery icon colour will change based on the % contribution of the power source (grid, solar) supplying the battery. Set to `false` to disable. If `priority_load_243: on` solar will prioritise the essential load. If `false` or ommited solar will prioritise the battery. | +| linear_gradient: | Optional | `true` | The blocks inside the battery icon that represent SOC will be coloured using a linear gradient that ranges from red to green | +| show_daily: | Optional | `false` | Toggles the daily total | +| animation_speed: | Optional | `6` | Set slowest animation speed in seconds, depending on power draw | +| max_power: | Optional | `4500` | Maximum power draw to calculate animation speed. Numeric value or sensor i.e. `number.battery_maximum_discharging_power` | +| show_absolute: | Optional | `false` | set to `true` to display power and current as absolute values +| auto_scale: | Optional | `true` | If set to `true` the card will use the entities `unit_of_measurement` attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the `decimal_places` card attribute apart from the daily energy values which are rounded to 1 decimal place | +| hide_soc: | Optional | `false` | If set to `true` the current program capacity (soc), or for Goodwe inverters the shutdown soc and offgrid shutdown soc that is shown to the left of the current battery SOC will be hidden. | +| show_remaining_energy: | Optional | `true` | Set to `true` to display the remaining battery energy in kWh based on the current SOC. Only visable on the `lite` and `full` cards | + +### Solar + +These attributes are only needed if `show_solar` is set to `true` + +| Attribute | Requirement | Default | Description | +|------------------|--------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| colour: | Optional | `orange`| Sets the colour of all the solar card objects. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc) +| show_daily: | Optional | `false` | Toggles the daily total +| display_mode: | Optional | `1` | `1` - Only display the daily total, `2` - Display the daily total and remaining daily forecast, `3` - Display the daily total and total solar generation +| dynamic_colour: | Optional | `true` | The solar elements on the card will be greyed out if total solar power < 10W. +| mppts: | **Required** | `2` | Specify the number of MPPT's in use `1`, `2`, `3` or `4` +| animation_speed: | Optional | `9` | Set slowest animation speed in seconds, depending on Power produced +| max_power: | Optional | `8000` | Maximum power draw to calculate animation speed +| pv1_name: | Optional | `PV1` | Set the disaply name for MPPT1 +| pv2_name: | Optional | `PV2` | Set the disaply name for MPPT2 +| pv3_name: | Optional | `PV3` | Set the disaply name for MPPT3 +| pv4_name: | Optional | `PV4` | Set the disaply name for MPPT4 +| auto_scale: | Optional | `true` | If set to `true` the card will use the entities `unit_of_measurement` attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the `decimal_places` card attribute apart from the daily energy values which are rounded to 1 decimal place + +### Load + +| Attribute | Requirement | Default | Description | +|--------------------|-------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| colour: | Optional | `'#5fb6ad'` | Setss the colour of all the load card objects. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc) | +| dynamic_colour: | Optional | `true` | The essential icon colour will change based on the % contribution of the power source (battery, grid, solar) supplying the load. Set to `false` to disable | +| dynamic_icon: | Optional | `true` | The essential icon will change when there is 100% contribution from a single power source (battery, grid, solar). Set to `false` to disable | +| invert_load: | Optional | `false` | Set to `true` if your sensor provides a negative number when the load is drawing power | +| show_daily: | Optional | `false` | Toggles the daily total. | +| show_daily_aux: | Optional | `false` | Toggles the daily AUX total. Only displayed if `show_aux` is set to `true` | +| show_aux: | Optional | `false` | Toggles the display of AUX | +| invert_aux: | Optional | `false` | Set to `true` if your sensor provides a positive number for AUX input and negative number for AUX output | +| show_absolute_aux: | Optional | `false` | set to `true` to display power as an absolute value +| animation_speed: | Optional | `8` | Set slowest animation speed in seconds, depending on Power draw | +| max_power: | Optional | `8000` | Maximum power draw to calculate animation speed | +| aux_name: | Optional | `Auxilary` | Set the display name for the AUX Load +| aux_type: | Optional | `default` | Sets the AUX image using preset or any mdi icon e.g. `mdi:ev-station`. Presets are: `gen`, `inverter` `default`, `oven`, `pump`, `aircon` and `boiler`. +| aux_colour: | Optional | `the load colour` | Sets the colour of all the AUX card objects. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc) | +| aux_dynamic_colour:| Optional | `true` | The respective aux elements on the card will be greyed out if aux power = 0W. | +| aux_off_colour: | Optional | `the load colour` | Sets the colour of the AUX icon and label when disconnected. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc) | +| aux_loads: | Optional | `0` | Display additional loads on the AUX side (`0/1/2`) +| aux_load1_name: | Optional | | Set the display name for the AUX load 1 +| aux_load2_name: | Optional | | Set the display name for the AUX load 2 +| aux_load1_icon: | Optional | | Set the AUX load 1 image using any mdi icon e.g. `mdi:ev-station` +| aux_load2_icon: | Optional | | Set the AUX load 2 image using any mdi icon e.g. `mdi:ev-station` +| essential_name: | Optional | `Essential` | Set the display name for the essential load +| additional_loads: | Optional | `0` | Display additional loads on the essential side (`0/1/2/3/4`). Three and four additional loads will only be visable when using the lite/compact card +| load1_name: | Optional | | Set the display name for the essential load 1 +| load2_name: | Optional | | Set the display name for the essential load 2 +| load3_name: | Optional | | Set the display name for the essential load 3 (Lite card only) +| load4_name: | Optional | | Set the display name for the essential load 4 (Lite card only) +| load1_icon: | Optional | none | Set the essential load 1 image using preset or any mdi icon e.g. `mdi:ev-station` Presets are: `boiler`, `pump`, `aircon`, `oven` | +| load2_icon: | Optional | none | Set the essential load 2 image using preset or any mdi icon e.g. `mdi:ev-station` Presets are: `boiler`, `pump`, `aircon`, `oven` | +| load3_icon: | Optional | none | Set the essential load 3 image using any mdi icon e.g. `mdi:ev-station` Presets are not available when showing 4 essential loads | +| load4_icon: | Optional | none | Set the essential load 4 image using any mdi icon e.g. `mdi:ev-station` Presets are not available when showing 4 essential loads | +| auto_scale: | Optional | `true` | If set to `true` the card will use the entities `unit_of_measurement` attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the `decimal_places` card attribute apart from the daily energy values which are rounded to 1 decimal place | + +### Grid + +| Attribute | Requirement | Default | Description | +|-----------------------|-------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| colour: | Optional | `'#5490c2'` | Sets the colour of all the grid card objects. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc). | +| grid_name: | Optional | | Set the display name for the grid | +| export_colour: | Optional | | Sets the colour of all the grid card objects when exporting (selling) energy. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc). If not set will use the `colour:` value defined above. | +| no_grid_colour: | Optional | | Sets the colour of all the grid card objects when there is no grid power. Hex codes (`'#66ff00'` etc) or names (`red`, `green`, `blue` etc). If not set will use the `colour:` value defined above total | +| grid_off_colour: | Optional | | Sets the colour of the grid icon when the grid is disconnected. | | +| show_daily_buy: | Optional | `false` | Toggles the daily buy total | +| show_daily_sell: | Optional | `false` | Toggles the daily sell total | +| show_nonessential: | Optional | `true` | Toggles the display of non-essential | +| nonessential_icon: | Optional | `default` | Change the non-essential image using presets or any mdi icon e.g. `mdi:ev-station`. Presets are:
`default` `oven`, `boiler`

`pump`, `aircon`
| +| nonessential_name: | Optional | `Non Essential` | Set the display name for the non-essential load +| additional_loads: | Optional | `0` | Toggle the display of additional loads on the non-essential side (`0/1/2/3`) The third load will only be displayed if the inverter timer schedules are not used due to limited space. Set the battery attribute `hide_soc: true` to display +| load1_name: | Optional | | Set the display name for the non-essential load 1 +| load2_name: | Optional | | Set the display name for the non-essential load 2 +| load3_name: | Optional | | Set the display name for the non-essential load 3 +| load1_icon: | Optional | `default` | Change the non-essential load 1 image using presets or any mdi icon e.g. `mdi:ev-station`. Presets are: `default`, `oven`, `boiler`, `pump`, `aircon` | +| load2_icon: | Optional | `default` | Change the non-essential load 2 image using presets or any mdi icon e.g. `mdi:ev-station`. Presets are: `default`, `oven`, `boiler`, `pump`, `aircon` | +| load3_icon: | Optional | none | Change the non-essential load 3 image using any mdi icon e.g. `mdi:ev-station`. | +| invert_grid: | Optional | `false` | Set to `true` if your sensor provides a negative number for grid import and positive number for grid export | +| show_absolute: | Optional | `false` | set to `true` to display power as absolute +| animation_speed: | Optional | `8` | Set slowest animation speed in seconds, depending on power draw | +| max_power: | Optional | `8000` | Maximum power draw to calculate animation speed | +| auto_scale: | Optional | `true` | If set to `true` the card will use the entities `unit_of_measurement` attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the `decimal_places` card attribute apart from the daily energy values which are rounded to 1 decimal place | +| energy_cost_decimals: | Optional | `2` | Sets the number of decimal places to display the buy and sell energy costs + +### Entities + +Entity attributes below have been appended with the modbus register # e.g. `pv2_power_187` to indicate which Sunsynk +register should be read when configuring your sensors. Replace the default sensors with your own specific sensor names. +It is important that your sensors read the expected modbus register value. If you have missing sensors for any attribute +set it to none i.e. `day_pv_energy_108: none`. This will hide the sensor data from the card. To display a placeholder +with a default value of 0 set it to `zero` or any other value i.e. `solarday_108: zero`. + +See the [WIKI](https://github.com/slipx06/sunsynk-power-flow-card/wiki/Sensor-Mappings) for more information on sensor +mappings if using other integration methods. + +| Attribute | Requirement | Default | Description | +|----------------------------|--------------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| use_timer_248: | Optional | `switch.sunsynk_toggle_system_timer` | Displays "Use timer" status as an icon next to the inverter. Set to `no` to hide | +| priority_load_243: | Optional | `switch.sunsynk_toggle_priority_load` | Shows if energy pattern is set to priority load or priority battery as an icon next to the inverter. Set to `no` to hide | +| day_battery_discharge_71: | Optional | `sensor.sunsynk_day_battery_discharge` | Daily battery usage (kWh) | +| day_battery_charge_70: | Optional | `sensor.sunsynk_day_battery_charge` | Daily battery charge (kWh) | +| day_load_energy_84: | Optional | `sensor.sunsynk_day_load_energy` | Daily load (kWh) | +| day_grid_import_76: | Optional | `sensor.sunsynk_day_grid_import` | Daily grid import (kWh) | +| day_grid_export_77: | Optional | `sensor.sunsynk_day_grid_export` | Daily grid export (kWh) | +| day_pv_energy_108: | Optional | `sensor.sunsynk_day_pv_energy` | Daily solar usage (kWh) | +| day_aux_energy: | Optional | | Sensor that provides the daily AUX energy (kWh) +| inverter_voltage_154: | Optional | `sensor.sunsynk_inverter_voltage` | Inverter L1 voltage (V) | +| inverter_voltage_L2: | Optional | | Inverter L2 voltage (V) | +| inverter_voltage_L3: | Optional | | Inverter L3 voltage (V) | +| load_frequency_192: | Optional | `sensor.sunsynk_load_frequency` | Load frequency (Hz) | +| inverter_current_164: | Optional | `sensor.sunsynk_inverter_current` | Inverter L1 current (A) | +| inverter_current_L2: | Optional | | Inverter L2 current (A) | +| inverter_current_L3: | Optional | | Inverter L3 current (A) | +| inverter_power_175: | Optional | `sensor.sunsynk_inverter_power` | Inverter power (W). Required if the essential_power attribute is set to `none` | +| grid_power_169: | Optional | `sensor.sunsynk_grid_power` | Grid power (W) See NOTE below. Use **167** (Grid LD Power) if non-essential and essential readings are wrong. Required if the nonessential_power attribute is set to `none` | +| pv1_power_186: | Optional | `sensor.sunsynk_pv1_power` | PV string 1 power (W) | +| pv2_power_187: | Optional | `sensor.sunsynk_pv2_power` | PV string 2 power (W) | +| pv3_power_188: | Optional | `sensor.sunsynk_pv3_power` | PV string 3 power (W) | +| pv4_power_189: | Optional | `sensor.sunsynk_pv4_power` | PV string 4 power (W) | +| pv_total: | Optional | `none` | Provide a sensor for total pv power. If omitted the card uses internal logic to calculate this based on the pv1-4 power (W) +| battery_voltage_183: | Optional | `sensor.sunsynk_battery_voltage` | Battery voltage (V) | +| battery_soc_184: | **Required** | `sensor.sunsynk_battery_soc` | Battery state of charge (%) | +| battery_power_190: | **Required** | `sensor.sunsynk_battery_power` | Battery power (W). Requires a negative number for battery charging and a positive number for battery discharging. Set the `invert_power:` battery attribute to `yes` if your sensor reports this the other way around | +| battery_current_191: | **Required** | `sensor.sunsynk_battery_current` | Battery current (A) | +| battery_temp_182: | Optional | `sensor.sunsynk_battery_temperature` | Battery temperature (℃) | +| battery_rated_capacity | Optional | | Battery rated capacity (Ah). If provided this sensor will be used to calculate battery energy. The`energy` attribute under the battery card configuration will be ignored. +| essential_power: | Optional | `none` | The card will automatically calculate this sensor based on the formula below if the attribute is set to `none` or the sensor is not defined. You can overide this by supplying a sensor that measures essential power e.g. `Load power Essential` in the case of Solar Assistant (W) | +| essential_load1: | Optional | | Sensor that contains the power of your essential load 1 (W). Can also be used to display any sensor data i.e. temp, energy etc if `auto_scale: false` | +| essential_load2: | Optional | | Sensor that contains the power of your essential load 2 (W). Can also be used to display any sensor data i.e. temp, energy etc if `auto_scale: false` | +| essential_load3: | Optional | | Sensor that contains the power of your essential load 3 (W). Can also be used to display any sensor data i.e. temp, energy etc if `auto_scale: false` For Lite view only | +| essential_load4: | Optional | | Sensor that contains the power of your essential load 4 (W). Can also be used to display any sensor data i.e. temp, energy etc if `auto_scale: false` For Lite view only | +| essential_load1_extra: | Optional | | Sensor that contains additional information you want displayed for your essential load 1 e.g. Daily kWh, Temperature etc +| essential_load2_extra: | Optional | | Sensor that contains additional information you want displayed for your essential load 2 e.g. Daily kWh, Temperature etc +| load_power_L1: | Optional | | Load L1 Power (W) +| load_power_L2: | Optional | | Load L2 Power (W) +| load_power_L3: | Optional | | Load L3 Power (W) +| nonessential_power | Optional | `none` | The card will automatically calculate this sensor based on the formula below if the attribute is set to `none` or the sensor is not defined. You can overide this by supplying a sensor that measures non-essential power e.g. `Load power Non-Essential` in the case of Solar Assistant. (W) +| non_essential_load1: | Optional | | Sensor that contains the power of your non-essential load 1 (W) | +| non_essential_load2: | Optional | | Sensor that contains the power of your non-essential load 2 (W) +| non_essential_load3: | Optional | | Sensor that contains the power of your non-essential load 3 (W) +| non_essential_load1_extra: | Optional | | Sensor that contains additional information you want displayed for your nonessential load 1 e.g. Daily kWh, Temperature etc +| non_essential_load2_extra: | Optional | | Sensor that contains additional information you want displayed for your nonessential load 2 e.g. Daily kWh, Temperature etc +| grid_ct_power_total: | Optional | | For three phase systems. The card will automatically calculate this based on (Grid CT L1 power + Grid CT L2 power + Grid CT L3 power) You can optionally provide your own sensor for total grid power. (W) +| grid_ct_power_172: | **Required** | `sensor.sunsynk_grid_ct_power` | Grid CT L1 power (W) | +| grid_ct_power_L2: | Optional | `none` | Grid CT L2 power (W) | +| grid_ct_power_L3: | Optional | `none` | Grid CT L3 power (W) | +| pv1_voltage_109: | Optional | `sensor.sunsynk_pv1_voltage` | PV string 1 voltage (V) | +| pv1_current_110: | Optional | `sensor.sunsynk_pv1_current` | PV string 1 current (A) | +| pv2_voltage_111: | Optional | `sensor.sunsynk_pv2_voltage` | PV string 2 voltage (V) | +| pv2_current_112: | Optional | `sensor.sunsynk_pv2_current` | PV string 2 current (A) | +| pv3_voltage_113: | Optional | `sensor.sunsynk_pv3_voltage` | PV string 3 voltage (V) | +| pv3_current_114: | Optional | `sensor.sunsynk_pv3_current` | PV string 3 current (A) | +| pv4_voltage_115: | Optional | `sensor.sunsynk_pv4_voltage` | PV string 4 voltage (V) | +| pv4_current_116: | Optional | `sensor.sunsynk_pv4_current` | PV string 4 current (A) | +| grid_connected_status_194: | Optional | `binary_sensor.sunsynk_grid_connected_status` | Grid connected status (case insensitive) `on/off`,`1/0`, `On-Grid/Off-Grid`, or `On Grid/Off Grid` | +| inverter_status_59: | Optional | `sensor.sunsynk_overall_state` | Expects a sensor that contains inverter status represented as a string or number. For Sunsynk `0, 1, 2, 3, 4` or `standby, selftest, normal, alarm, fault`. For Lux `0,1,2,4,5,7,8,9,10,11,12,16,17,20,32,40,64,136,192`. For Solis expects a numeric value `0-57`. For Goodwe `0,1,2,3,4,5` or `Wait mode, Normal (On-Grid), Normal (Off-Grid), Fault Mode, Flash Mode, Check Mode`. For Goodwe_gridmode `0,1,2` or `Idle, Exporting, Importing` | +| battery_status: | Optional | `sensor.battery_mode_code` | Used only when inverter model is set to `goodwe`, `goodwe_gridmode` or `huawei`. Battery status `0, 1, 2, 3, 4` | +| aux_power_166: | Optional | `sensor.sunsynk_aux_power` | Auxilary power (W) | +| aux_load1: | Optional | | Sensor that contains the power of your AUX load 1 (W) | +| aux_load2: | Optional | | Sensor that contains the power of your AUX load 2 (W) | +| aux_load1_extra: | Optional | | Sensor that contains additional information you want displayed for your aux load 1 e.g. Daily kWh, Temperature etc | +| aux_load2_extra: | Optional | | SSensor that contains additional information you want displayed for your aux load 2 e.g. Daily kWh, Temperature etc | +| aux_connected_status: | Optional | | AUX Connected Status `on/off` or `1/0` +| remaining_solar: | Optional | `sensor.solcast_forecast_remaining_today` | The remaining solar forecast for the day (kWh). Use with solar `display_mode:2` | +| total_pv_generation: | Optional | | Total Solar generation (Lifetime or forecast for the day) (kWh). Use with solar `display_mode:3` | +| radiator_temp_91: | Optional | `sensor.sunsynk_radiator_temperature` | Inverter AC temperature (℃) | +| environment_temp: | Optional | | Display outside temperature or other environment temperature below the sun icon | +| dc_transformer_temp_90: | Optional | `sensor.sunsynk_dc_transformer_temperature` | Inverter DC temperature (℃) | +| prog1_time: | Optional | `sensor.sunsynk_time_slot_1` | Program 1 start time (`HH:MM`) +| prog1_capacity: | Optional | `number.sunsynk_system_mode_soc_time1` | Program 1 capacity (SOC) setting +| prog1_charge: | Optional | `switch.sunsynk_system_mode_grid_charge_time1` | Program 1 charge options (`on/off`, `1/0`, `No Grid or Gen`) +| prog2_time: | Optional | `sensor.sunsynk_time_slot_2` | Program 2 start time (`HH:MM`) +| prog2_capacity: | Optional | `number.sunsynk_system_mode_soc_time2` | Program 2 capacity (SOC) setting +| prog2_charge: | Optional | `switch.sunsynk_system_mode_grid_charge_time2` | Program 2 charge options (`on/off`, `1/0`, `No Grid or Gen`) +| prog3_time: | Optional | `sensor.sunsynk_time_slot_3` | Program 3 start time (`HH:MM`) +| prog3_capacity: | Optional | `number.sunsynk_system_mode_soc_time3` | Program 3 capacity (SOC) setting +| prog3_charge: | Optional | `switch.sunsynk_system_mode_grid_charge_time3` | Program 3 charge options (`on/off`, `1/0`, `No Grid or Gen`) +| prog4_time: | Optional | `sensor.sunsynk_time_slot_4` | Program 4 start time (`HH:MM`) +| prog4_capacity: | Optional | `number.sunsynk_system_mode_soc_time4` | Program 4 capacity (SOC) setting +| prog4_charge: | Optional | `switch.sunsynk_system_mode_grid_charge_time4` | Program 4 charge options (`on/off`, `1/0`, `No Grid or Gen`) +| prog5_time: | Optional | `sensor.sunsynk_time_slot_5` | Program 5 start time (`HH:MM`) +| prog5_capacity: | Optional | `number.sunsynk_system_mode_soc_time5` | Program 5 capacity (SOC) setting +| prog5_charge: | Optional | `switch.sunsynk_system_mode_grid_charge_time5` | Program 5 charge options (`on/off`, `1/0`, `No Grid or Gen`) +| prog6_time: | Optional | `sensor.sunsynk_time_slot_6` | Program 6 start time (`HH:MM`) +| prog6_capacity: | Optional | `number.sunsynk_system_mode_soc_time6` | Program 6 capacity (SOC) setting +| prog6_charge: | Optional | `switch.sunsynk_system_mode_grid_charge_time6` | Program 6 charge options (`on/off`, `1/0`, `No Grid or Gen`) +| energy_cost_buy: | Optional | | Sensor that provides current buy energy cost per kWh +| energy_cost_sell: | Optional | | Sensor that provides current sell energy cost per kWh +| solar_sell_247: | Optional | `switch.sunsynk_toggle_solar_sell` | Displays icons to indicate if sell solar is active or not. The switch can be toggled by clicking on the icon (`on/off`, `1/0`) +| grid_voltage: | Optional | `sensor.solis_grid_voltage` | Sensor providing grid voltage (v). Used only when inverter model is set to `solis` +| battery_current_direction: | Optional | `sensor.solis_battery_current_direction` | Used only when inverter model is set to `solis` (`0`, `1`) +| prepaid_units: | Optional | | Account balance of prepaid electricity units + + +The card calculates the sensors below based on supplied attributes in the config so you dont need to define them in Home +Assistant. NOTE if your essential and non-essential readings are innacurate replace sensor 169 with 167. Alternatively +provide the card with sensors that calculate this data i.e essential_power: and nonessential_power: + +If `three_phase:false` + + ``` + totalsolar = pv1_power_186 + pv2_power_187 + pv3_power_188 + pv4_power_189 + nonessential = grid_ct_power_172 - grid_power_169 + essential = inverter_power_175 + grid_power_169 - aux_power_166 + ``` + +If `three_phase:true` + +``` + totalsolar = pv1_power_186 + pv2_power_187 + pv3_power_188 + pv4_power_189 + nonessential = grid_ct_power_172 + grid_ct_power_L2 + grid_ct_power_L3 - grid_power_169 + essential = load_power_L1 + load_power_L2 + load_power_L3 + ``` + +The modbus registers can be visualised on the `full` card below: + +![image](https://user-images.githubusercontent.com/7227275/235479493-b322d5b2-f2b1-431f-9048-f845fc2989b4.png) diff --git a/_sources/contribute/bugs.rst.txt b/_sources/contribute/bugs.rst.txt new file mode 100644 index 00000000..688bf714 --- /dev/null +++ b/_sources/contribute/bugs.rst.txt @@ -0,0 +1,52 @@ +############## +Reporting Bugs +############## + +This section guides you through submitting a bug report for the Sunsynk Power Flow Card. +Following these guidelines helps maintainers and the community understand your report, +reproduce the behaviour, and find related reports. + +Before creating bug reports, please check the below information as you might find out +that you don't need to create one. When you are creating a bug report, +please include as many details as possible, the information it asks for helps +us resolve issues faster. + +.. note:: + + If you find a **Closed** issue that seems like it is the same thing that you're + experiencing, open a new issue and include a link to the original issue in the + body of your new one. + + +****************************** +Before Submitting A Bug Report +****************************** + +* **Perform a** `cursory search `_ + to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to + the existing issue instead of opening a new one. + +***************************** +How do i submit a bug report? +***************************** + +Bugs are tracked as `GitHub issues `_. +After you've determined this is not a configuration issue, create an issue on github +and provide the following information by filling in `the template `_. + +Explain the problem and include additional details to help maintainers reproduce the problem: + +- **Use a clear and descriptive title** for the issue to identify the problem. +- **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you installed the plugin. When listing steps, **don't just say what you did, but explain how you did it**. For example, did you use the Lovelace Editor or do the change in YAML directly. +- **Provide specific examples to demonstrate the steps**. Include screenshots, or copy/pasteable configuration snippets, which you use in those examples. If you're providing snippets in the issue, use `Markdown code blocks `_. +- **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour. +- **Explain which behaviour you expected to see instead and why.** +- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. +- **If Chrome's developer tools pane is showing errors**, include these in your report +- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. + +Provide more context by answering these questions: + +- **Did the problem start happening recently** (e.g. after updating to a new version of HA / Sunsynk Power Flow Card) or was this always a problem? +- If the problem started happening recently, **can you reproduce the problem in an older version of the card?** What's the most recent version in which the problem doesn't happen? You can install older versions of Atomic Calendar Revive via HACS or from the releases page on github +- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. diff --git a/_sources/contribute/devcontainer.rst.txt b/_sources/contribute/devcontainer.rst.txt new file mode 100644 index 00000000..798bdb68 --- /dev/null +++ b/_sources/contribute/devcontainer.rst.txt @@ -0,0 +1,37 @@ +###################### +VS Code - DevContainer +###################### + +The easiest way to get your development environment setup is by using VS Code +with Dev Containers, this utilises Docker containers to setup a development +environment that guarantees a match with all other developers, removing any +potential headaches from incompatibilities. + +************ +Requirements +************ + +* VS Code +* Docker +* Remote - Containers (VS Code extension) + + +************* +Configuration +************* + +#. Copy the ``recommended`` files inside ``.devcontainer`` +#. Paste them in the same folder, remove the ``recommended-`` from the filename +#. In most cases no other changes will be required with these files + +.. note:: + Please ensure that the ``recommended-xxx`` files are not removed as this would remove + them from the repository when committed. + +When you open the repository with VS Code, a prompt to "Reopen in container" should +now appear. This will start the build of the development container with all components +and extensions pre-installed. + +.. note:: + If you don't see the notification, open the command pallet and select + ``Dev Containers: Open Folder in Container`` diff --git a/_sources/contribute/devcycle.rst.txt b/_sources/contribute/devcycle.rst.txt new file mode 100644 index 00000000..aeb274f7 --- /dev/null +++ b/_sources/contribute/devcycle.rst.txt @@ -0,0 +1,125 @@ +################# +Development Cycle +################# + +The below will provide a guide on how you should develop for this plugin to have your +code reviewed and accepted. + +**************** +Setup Repository +**************** + +* Fork the repo in `github `_ +* Clone the project to your development machine + +.. code-block:: bash + + git clone https://github.com/your-username/sunsynk-power-flow-card.git + +******************* +Create Topic Branch +******************* + +You should always work on a new topic branch for each feature / bug you are working on. +Also you must ensure that you have pulled the latest version from upstream see below. + +Start by setting up an upstream remote, this will be used to pull the latest version +from the main repository: + +.. code-block:: bash + + git remote add upstream https://github.com/slipx06/sunsynk-power-flow-card + + +Checkout the master branch and pull the latest upstream version: + +.. code-block:: bash + + git checkout master + git fetch upstream + git merge upstream/master + git push + +Your fork should now be in sync with the main repository, now a new branch +is required for development. + +.. code-block:: bash + + git checkout -b _ + git checkout -b 100_Fix-the-bug + + +.. note:: + + The branch should have a relevant short name starting with the issue number + and then having a name for the fix / feature as shown in the example above. + +******************** +Install Dependencies +******************** + +From the cloned repository, run the command to install the requirements: + +.. code-block:: bash + + yarn install + +******************** +Make changes & Build +******************** + +#. Any changes to the card should be made in the folder ``src`` +#. Update the version number in ``package.json`` +#. Run the command ``yarn run build`` to create the latest distribution file + +******* +Testing +******* + +There are no automated tests for this project, however it is expected that any +development work is tested against a HA Server with working inverter integration, +this ensures no adverse impact is added with the feature or bugfix. + +********** +Versioning +********** + +This project follows `Semantic Versioning `_ + +**MAJOR.MINOR.PATCH** + +In the context of semantic versioning, the following should apply: + +* **Major** - A breaking change that requires user invervention, or a change to a + default value. +* **Minor** - A change that does not require intervention, or adds additional + functionality in a backwards compatible manner. +* **Patch** - A change that resolves a specific bug. + +All changes are tracked in the `release notes `_ + + +************** +Commit Changes +************** + +Once you are happy with the changes, these can be committed: + +.. code-block:: bash + + git add . + git commit -v -m "feat: 100 Added new feature" + +.. note:: + + Commit messages should follow `conventional commits `_ + this ensures clear commit messages within the repository. + + +******************* +Submit Pull Request +******************* + +Once development & testing are completed a pull request can be submitted for +the change that is required, ensure that all tests are passing and once they +are a member of the team will review the request, test and merge if appropriate diff --git a/_sources/contribute/docs.rst.txt b/_sources/contribute/docs.rst.txt new file mode 100644 index 00000000..4e57cd1f --- /dev/null +++ b/_sources/contribute/docs.rst.txt @@ -0,0 +1,26 @@ +############# +Documentation +############# + +The documentation for this repo is built using Sphinx, the site is re-built +on each release of the card and pushed to github pages. + +***************** +How to Contribute +***************** + +There are two ways of contributing to the documentation: + +#. Editing the files within the ``docs`` folder. +#. Raising an issue for something to be fixed on the next release. + +The documentation utilises `Sphinx RestructuredText `_ + +************ +Adding pages +************ + +To add new pages, add a new file in the appropriate directory, and then add a reference +to the ``toc.rst`` file under the correct heading. + +You can test the pages added by running the command ``yarn run docs-build`` diff --git a/_sources/examples/foxess.rst.txt b/_sources/examples/foxess.rst.txt new file mode 100644 index 00000000..f34a762c --- /dev/null +++ b/_sources/examples/foxess.rst.txt @@ -0,0 +1,102 @@ +################ +FoxESS Inverter +################ + +****************************************************************************************** +Example 1 - Integration via https://github.com/nathanmarlor/foxess_modbus +****************************************************************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + panel_mode: true + card_width: 80% + show_solar: true + inverter: + auto_scale: true + colour: '#b6baa9' + modern: true + model: foxess + autarky: power + battery: + energy: 33000 + shutdown_soc: 35 + colour: pink + max_power: 9000 + show_daily: true + auto_scale: true + solar: + show_daily: true + mppts: 3 + auto_scale: true + max_power: 5000 + pv1_name: 1 South F + pv2_name: 2 South R + pv3_name: 3 North + load: + show_daily: false + auto_scale: true + additional_loads: 2 + load1_name: HW + load1_icon: mdi:water-boiler + load2_name: Kitchen + load2_icon: mdi:stove + show_aux: true + aux_name: Climate + aux_loads: 2 + aux_load1_name: Mitsu AC/Heat + aux_load1_icon: mdi:heat-pump-outline + aux_load2_name: Mirror Heater + aux_load2_icon: mdi:mirror-rectangle + essential_name: Main + grid: + show_daily_buy: true + show_daily_sell: true + max_power: 12000 + auto_scale: true + show_nonessential: true + nonessential_name: EV + nonessential_icon: mdi:ev-station + invert_grid: true + entities: + use_timer_248: 'no' + priority_load_243: 'no' + inverter_voltage_154: sensor.emontx4_vrms + inverter_current_164: sensor.foxess_rcurrent + inverter_power_175: sensor.foxess_rpower + grid_connected_status_194: sensor.foxess_inverter_state + inverter_status_59: sensor.foxess_inverter_state + day_battery_charge_70: sensor.foxess_battery_charge_today + day_battery_discharge_71: sensor.foxess_battery_discharge_today + battery_voltage_183: sensor.foxess_batvolt + battery_soc_184: sensor.foxess_battery_soc + battery_power_190: sensor.foxess_invbatpower + battery_current_191: sensor.foxess_invbatcurrent + day_grid_import_76: sensor.foxess_grid_consumption_energy_today + day_grid_export_77: sensor.foxess_feed_in_energy_today + grid_power_169: sensor.foxess_load_power + grid_ct_power_172: sensor.foxess_grid_ct + day_load_energy_84: sensor.foxess_load_energy_today + essential_power: sensor.essential_total_power + nonessential_power: sensor.emontx4_p3 + aux_power_166: sensor.aux_total_power + day_pv_energy_108: sensor.foxess_solar_energy_today + pv1_power_186: sensor.foxess_pv1_power + pv2_power_187: sensor.foxess_pv2_power + pv3_power_188: sensor.foxess_pv3_power + pv1_voltage_109: sensor.foxess_pv1_voltage + pv1_current_110: sensor.foxess_pv1_current + pv2_voltage_111: sensor.foxess_pv2_voltage + pv2_current_112: sensor.foxess_pv2_current + pv3_voltage_113: sensor.foxess_pv3_voltage + pv3_current_114: sensor.foxess_pv3_current + nonessential_load1: sensor.emontx4_p3 + essential_load1: sensor.emontx4_p8 + essential_load2: sensor.kitchen_power + aux_load1: sensor.emontx4_p12 + aux_load2: sensor.shlyclkrm_heater_power + aux_load2_extra: sensor.shlycloakroom_temperature_2 + energy_cost_buy: sensor.octopus_energy_electricity_xxx_yyy_current_rate + energy_cost_sell: sensor.octopus_energy_electricity_xxx_yyy_export_current_rate diff --git a/_sources/examples/goodwe.rst.txt b/_sources/examples/goodwe.rst.txt new file mode 100644 index 00000000..a8ff88c8 --- /dev/null +++ b/_sources/examples/goodwe.rst.txt @@ -0,0 +1,108 @@ +################ +Goodwe Inverter +################ + +********* +Example 1 +********* + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: lite + panel_mode: false + large_font: true + title: Goodwe + title_colour: grey + title_size: 32px + show_solar: true + show_battery: true + show_grid: true + inverter: + modern: false + colour: grey + autarky: energy + model: goodwe_gridmode + three_phase: true + battery: + energy: 10650 + shutdown_soc: sensor.goodwe_shutdown_soc + invert_power: false + show_daily: true + max_power: 5400 + show_absolute: false + auto_scale: true + solar: + show_daily: true + display_mode: 3 + mppts: 2 + animation_speed: 9 + max_power: 5400 + pv1_name: East + pv2_name: West + load: + show_daily: true + grid: + show_nonessential: true + invert_grid: false + export_colour: green + entities: + day_battery_discharge_71: sensor.today_battery_discharge + day_battery_charge_70: sensor.today_battery_charge + day_load_energy_84: sensor.today_load + day_pv_energy_108: sensor.today_s_pv_generation + inverter_voltage_154: sensor.on_grid_l1_voltage + inverter_voltage_L2: sensor.on_grid_l2_voltage + inverter_voltage_L3: sensor.on_grid_l3_voltage + load_frequency_192: sensor.meter_frequency + inverter_current_164: sensor.on_grid_l1_current + inverter_current_L2: sensor.on_grid_l2_current + inverter_current_L3: sensor.on_grid_l3_current + inverter_power_175: zero + pv1_power_186: sensor.pv1_power + pv2_power_187: sensor.pv2_power + pv_total: sensor.pv_power + battery_voltage_183: sensor.battery_voltage + battery_soc_184: sensor.battery_state_of_charge + battery_power_190: sensor.battery_power + battery_current_191: sensor.battery_current + essential_power: sensor.house_consumption + load_power_L1: sensor.load_l1 + load_power_L2: sensor.load_l2 + load_power_L3: sensor.load_l3 + grid_ct_power_172: sensor.active_power_l1 + grid_ct_power_L2: sensor.active_power_l2 + grid_ct_power_L3: sensor.active_power_l3 + grid_ct_power_total: sensor.active_power + pv1_voltage_109: sensor.pv1_voltage + pv1_current_110: sensor.pv1_current + pv2_voltage_111: sensor.pv2_voltage + pv2_current_112: sensor.pv2_current + grid_connected_status_194: sensor.grid_mode_code + inverter_status_59: sensor.work_mode_code + battery_status: sensor.battery_mode_code + total_pv_generation: sensor.total_pv_generation + battery_temp_182: sensor.battery_temperature + radiator_temp_91: sensor.inverter_temperature_radiator + dc_transformer_temp_90: sensor.inverter_temperature_air + day_grid_import_76: sensor.energy_buy_daily + day_grid_export_77: sensor.energy_sell_daily + remaining_solar: sensor.energy_production_today_total + energy_cost_buy: sensor.spot_price_buy + energy_cost_sell: sensor.spot_price_sell + +.. note:: + + The Goodwe integration does not provide a sensor for ``shutdown_soc``. + A template sensor can be created using the provided depth of discharge (DOD) sensor i.e ``number.depth_of_discharge_on_grid``. + See example below. Note that the depth of discharge sensor name may vary depending on your HA language. + +.. code-block:: bash + + - sensor: + - name: GoodWe Shutdown SOC + unique_id: goodwe_shutdown_soc + unit_of_measurement: "%" + icon: mdi:battery-arrow-down + state: "{{100 - states('number.depth_of_discharge_on_grid') | int }}" \ No newline at end of file diff --git a/_sources/examples/huawei.rst.txt b/_sources/examples/huawei.rst.txt new file mode 100644 index 00000000..9883190e --- /dev/null +++ b/_sources/examples/huawei.rst.txt @@ -0,0 +1,933 @@ +################## + Huawei Inverter +################## + +.. note:: + + Please report all feedback or Issues to the Discussion (Support Sections) of: https://github.com/Roving-Ronin/sunsynk-power-flow-card. + +To use the Sunsynk card with Huawei Solar (or iStore in Australia) you need to copy the huawei_derived_sensors.yaml and sunsynk_card_derived_sensors.yaml files to your /homeassistant/packages directory. Upon restarting Home Assistant this will create all the required derived sensors, based upon the baseline sensors from the WLCRS integration, needed to populate the Sunsynk card. In addition to this, you will need to find an electricity_costs_xxx.yaml file that matches your electricity providers tariff plan, or is similiar and you can customise the 'Electrity - Price', 'Electricity - FIT' and 'Energy Meter' sections to reflect your rate plan costs and usage period(s), all these files are available from: https://github.com/slipx06/sunsynk-power-flow-card/tree/master/docs/examples/huawei_packages. + +.. Required Sensor Groups:: + +Whilst it would be simplest to create the additional 'sensor groups' using yaml files, this has the disadvantage that if later on you want to add or remove devices individual sensors to/from these groups, you are unable to do so by editing them within Home Assistant GUI. Given the flexibility manually creating these sensors groups via the GUI provides, you will need to create the following groups (below) manually. This is done by going to Settings --> Devices & Services --> Helpers, clicking the 'Create Helper' button. From the choice of group types then select 'Sensor Group' and set the 'Type' to SUM. Follow the instructions below for the names to enter for the groups and the member/entities to add into each group. + +.. csv-table:: REQUIRED MANUALLY CREATED SENSOR GROUPS: + :header: "Group Name", "Entity ID", "Unit of Measurement"," "Purpose + :widths: 30, 40, 5, 45 + + "Sunsynk Card - AUX - Energy Daily", "sunsynk_card_aux_energy_daily", "kWh", "Required for the day_aux_energy entity, that shows the AUX Daily kWh consumed. Group should be populated with the daily energy sensors of all the devices monitored in AUX1 and AUX2" + "Sunsynk Card - AUX - Active Power", "sunsynk_card_aux_active_power", "W", "Required for the aux_power_166 entity, that shows the total Active Power for AUX1 and AUX2. Group should be populated with the Active Power sensors of all the devices monitored in AUX1 and AUX2" + "Sunsynk Card - Non Essential - Active Power", "sunsynk_card_non_essential_active_power", "W", "Required for the essential_power entity, that shows the tota Active Power for Non-Essential. Group should be populated with the Active Power sensors of all the non-essntial devices monitored, such as HVAC, EV Charger or Hot Power Pumps." + +________________________ + +To work with the Sunsynk card and the additional derived sensors, some sensors that are disabled by default by the WLCRS integration, must be manually enabled. Listed below the the various devices and the list of sensors for each, that are required to be enabled (at a minimum). + + +.. csv-table:: POWER METER: + :header: "Single Phase Installation", "Three phase Installation" + + "Active Power", "Active Power" + "Consumption", "Consumption" + "Current", "Current" + "Exported", "Exported" + "Frequency", "Frequency" + "-", "Phase A - Active Power" + "-", "Phase A - Current" + "Voltage", "Phase A - Voltage" + "-", "Phase B - Active Power" + "-", "Phase B - Current" + "-", "Phase B - Voltage" + "-", "Phase C - Active Power" + "-", "Phase C - Current" + "-", "Phase C - Voltage" + "Power Factor", "Power Factor" + +.. csv-table:: INVERTER(S): + :header: "Single Phase Installation", "Three Phase Installation" + + "Active Power", "Active Power" + "Daily Yield", "Daily Yield" + "Day Active Peak Power", "Day Active Peak Power" + "Efficiency", "Efficiency" + "Input Power", "Input Power" + "Internal Temperature", "Internal Temperature" + "Phase A Current", "Phase A Current" + "-", "Phase B Current" + "-", "Phase C Current" + "PV 1 Current", "PV 1 Current" + "PV 1 Voltage", "PV 1 Voltage" + "PV 2 Current", "PV 2 Current" + "PV 2 Voltage", "PV 2 Voltage" + "Total Yield", "Total Yield" + +.. csv-table:: LUNA ESS BATTERY(S): + :header: "Sensor", "Comment" + + "Bus Current", "-" + "Bus Voltage", "-" + "Capacity Control Periods", "Not used currently, future function envisioned" + "Charge/Discharge Power", "-" + "Day Charge", "-" + "Day Discharge", "-" + "Fixed Charging Periods", "-" + "State of Capacity", "-" + "Battery 1 Temperature", "-" + "Battery 2 Temperature", "Optional" + "Time of Use Periods", "Not used currently, future function envisioned" + "Total Charge", "-" + "Total Discharge", "-" + +With these sensors active, you can then following the installation instructions for the Sunsynk card, however when you add the card to Home Assistant, change to the 'Show Code Editor' view and paste the example code below (that most closely matches your Huawei/iStore setup) into the editor, replacing all the default code shown. Finally, validate the example code copied from below, updating to suite your setup. + +________________________ + +.. note:: + + Data sources for the Sunsynk card is provided by the use of the WLCRS "Huawei Solar" integration - https://github.com/wlcrs/huawei_solar/wiki, as well as the Energy Meter integration https://github.com/zeronounours/HA-custom-component-energy-meter, must be installed prior to installing the Sunsynk card. + + +______________________________________________________________ + +*********************************************************************************************** +Example 1 - 1 x L1 1phase inverter with a 15kWh LUNA ESS battery - 2 PV strings (6.6kW) +*********************************************************************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + panel_mode: false + large_font: false + title: Huawei - Power Monitor + title_size: 18px + show_solar: true + show_grid: true + show_battery: true + decimal_places: 2 + dynamic_line_width: true + inverter: + modern: false + colour: grey + autarky: power + auto_scale: true + model: huawei + three_phase: false + battery: + energy: 14850 + shutdown_soc: sensor.battery_end_of_discharge_soc + invert_power: true + colour: '#fc8d83' + show_daily: true + animation_speed: 5 + max_power: 5000 + show_absolute: true + auto_scale: true + hide_soc: false + show_remaining_energy: true + dynamic_colour: true + linear_gradient: true + solar: + colour: '#F7BC00' + show_daily: true + mppts: 2 + animation_speed: 8 + max_power: 6600 + pv1_name: Inv1.S1 + pv2_name: Inv2.S1 + display_mode: 2 + auto_scale: true + load: + colour: magenta + show_daily: true + show_daily_aux: true + show_aux: true + invert_aux: false + show_absolute_aux: false + aux_name: Generator + aux_type: gen + aux_colour: '#5490c2' + aux_off_colour: brown + aux_loads: 2 + aux_load1_name: IT - Servers + aux_load2_name: IT - Network + aux_load1_icon: mdi:server-network + aux_load2_icon: mdi:network + animation_speed: 4 + essential_name: Essential + max_power: 4000 + additional_loads: 2 + load1_name: Lights + load2_name: All GPO + load3_name: Spare + load4_name: Spare + load1_icon: mdi:lightbulb + load2_icon: mdi:power-plug + load3_icon: mdi:water-boiler + load4_icon: mdi:kettle + auto_scale: true + dynamic_icon: true + dynamic_colour: true + grid: + grid_name: Your-Grid-Name + colour: '#FF2400' + export_colour: green + no_grid_colour: '#a40013' + grid_off_colour: '#e7d59f' + show_daily_buy: true + show_daily_sell: true + show_nonessential: true + invert_grid: true + nonessential_name: Non Essential + nonessential_icon: none + additional_loads: 2 + load1_name: HVAC + load2_name: EV + load1_icon: mdi:fan + load2_icon: mdi:car + animation_speed: 7 + max_power: 15000 + auto_scale: true + dynamic_icon: true + dynamic_colour: true + energy_cost_decimals: 3 + entities: + use_timer_248: null + priority_load_243: null + day_battery_charge_70: sensor.batteries_day_charge + day_battery_discharge_71: sensor.batteries_day_discharge + day_load_energy_84: sensor.house_consumption_energy_daily + day_grid_import_76: sensor.hs_grid_imported_daily + day_grid_export_77: sensor.hs_grid_exported_daily + day_pv_energy_108: sensor.inverters_daily_yield + day_aux_energy: sensor.sunsynk_card_aux_energy_daily + inverter_voltage_154: sensor.power_meter_voltage + load_frequency_192: sensor.power_meter_frequency + grid_power_169: sensor.house_consumption_power + inverter_current_164: sensor.inverter_phase_a_current + inverter_power_175: sensor.inverters_active_power + inverter_status_59: sensor.inverters_state + radiator_temp_91: null + dc_transformer_temp_90: sensor.inverters_internal_temperature + pv1_power_186: sensor.inverter_1_pv_1_power + pv2_power_187: sensor.inverter_1_pv_2_power + pv_total: sensor.inverters_input_power + environment_temp: sensor._temp + remaining_solar: sensor.energy_production_today_remaining + pv1_voltage_109: sensor.inverter_pv_1_voltage + pv1_current_110: sensor.inverter_pv_1_current + pv2_voltage_111: sensor.inverter_pv_2_voltage + pv2_current_112: sensor.inverter_pv_2_current + battery_voltage_183: sensor.batteries_bus_voltage + battery_soc_184: sensor.batteries_state_of_capacity + battery_power_190: sensor.batteries_charge_discharge_power + battery_current_191: sensor.batteries_bus_current + battery_temp_182: sensor.batteries_temperature + battery_status: sensor.batteries_status + essential_power: sensor.house_consumption_power_less_aux_non_essential + essential_load1: sensor.lights_all_active_power + essential_load2: sensor.gpo_all_active_power_less_known + essential_load1_extra: null + essential_load2_extra: null + nonessential_power: sensor.sunsynk_card_non_essential_active_power + non_essential_load1: sensor.hvac_active_power + non_essential_load2: sensor.ev_charger_active_power + grid_ct_power_172: sensor.power_meter_active_power + grid_ct_power_total: sensor.power_meter_active_power + grid_connected_status_194: sensor.inverters_off_grid_status + aux_power_166: sensor.sunsynk_card_aux_active_power + aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status + energy_cost_buy: sensor.electricity_price + energy_cost_sell: sensor.electricity_fit + solar_sell_247: switch.null + aux_load1: sensor.it_hardware_network_active_power + aux_load2: sensor.it_hardware_servers_active_power + aux_load1_extra: sensor.env_network_rack_bme280_temperature + aux_load2_extra: sensor.garage_controller_bme280_temperature + grid_voltage: sensor.power_meter_voltage + + + +************************************************************************************************** +Example 2 - 2 x L1 1phase inverter with a 15kWh LUNA ESS battery - 4 PV strings (13.2kW) +************************************************************************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + panel_mode: false + large_font: false + title: Huawei - Power Monitor + title_size: 18px + show_solar: true + show_grid: true + show_battery: true + decimal_places: 2 + inverter: + modern: false + colour: grey + autarky: power + auto_scale: true + model: huawei + three_phase: false + battery: + energy: 14850 + shutdown_soc: sensor.battery_end_of_discharge_soc + invert_power: true + colour: '#fc8d83' + show_daily: true + animation_speed: 5 + max_power: 5000 + show_absolute: true + auto_scale: true + hide_soc: false + show_remaining_energy: true + dynamic_colour: true + linear_gradient: true + solar: + colour: '#F7BC00' + show_daily: true + mppts: 4 + animation_speed: 8 + max_power: 13200 + pv1_name: Inv1.S1 + pv2_name: Inv2.S1 + pv3_name: Inv1.S2 + pv4_name: Inv2.S2 + display_mode: 2 + load: + colour: magenta + show_daily: true + show_daily_aux: true + show_aux: true + invert_aux: false + show_absolute_aux: false + aux_name: Generator + aux_type: gen + aux_colour: '#5490c2' + aux_off_colour: brown + aux_loads: 2 + aux_load1_name: IT - Servers + aux_load2_name: IT - Network + aux_load1_icon: mdi:server-network + aux_load2_icon: mdi:network + animation_speed: 4 + essential_name: Essential + max_power: 4000 + additional_loads: 2 + load1_name: Lights + load2_name: All GPO + load3_name: Spare + load4_name: Spare + load1_icon: mdi:lightbulb + load2_icon: mdi:power-plug + load3_icon: mdi:water-boiler + load4_icon: mdi:kettle + auto_scale: true + dynamic_icon: true + dynamic_colour: true + grid: + grid_name: Your-Grid-Name + colour: '#FF2400' + export_colour: green + no_grid_colour: '#a40013' + grid_off_colour: '#e7d59f' + show_daily_buy: true + show_daily_sell: true + show_nonessential: true + invert_grid: true + nonessential_name: Non Essential + nonessential_icon: none + additional_loads: 2 + load1_name: HVAC + load2_name: EV + load1_icon: mdi:fan + load2_icon: mdi:car + animation_speed: 7 + max_power: 10000 + auto_scale: true + dynamic_icon: true + dynamic_colour: true + energy_cost_decimals: 3 + entities: + use_timer_248: null + priority_load_243: null + day_battery_charge_70: sensor.batteries_day_charge + day_battery_discharge_71: sensor.batteries_day_discharge + day_load_energy_84: sensor.house_consumption_energy_daily + day_grid_import_76: sensor.hs_grid_imported_daily + day_grid_export_77: sensor.hs_grid_exported_daily + day_pv_energy_108: sensor.inverters_daily_yield + day_aux_energy: sensor.sunsynk_card_aux_energy_daily + inverter_voltage_154: sensor.power_meter_voltage + load_frequency_192: sensor.power_meter_frequency + inverter_current_164: sensor.inverter_phase_a_current + inverter_power_175: sensor.inverters_active_power + inverter_status_59: sensor.inverters_state + radiator_temp_91: null + dc_transformer_temp_90: sensor.inverters_internal_temperature + pv1_power_186: sensor.inverter_1_pv_1_power + pv2_power_187: sensor.inverter_1_pv_2_power + pv3_power_188: sensor.inverter_2_pv_1_power + pv4_power_189: sensor.inverter_2_pv_2_power + pv_total: sensor.inverters_input_power + environment_temp: sensor._temp + remaining_solar: sensor.energy_production_today_remaining + pv1_voltage_109: sensor.inverter_pv_1_voltage + pv1_current_110: sensor.inverter_pv_1_current + pv2_voltage_111: sensor.inverter_pv_2_voltage + pv2_current_112: sensor.inverter_pv_2_current + pv3_voltage_113: sensor.inverter_pv_1_voltage_2 + pv3_current_114: sensor.inverter_pv_1_current_2 + pv4_voltage_115: sensor.inverter_pv_2_voltage_2 + pv4_current_116: sensor.inverter_pv_2_current_2 + battery_voltage_183: sensor.batteries_bus_voltage + battery_soc_184: sensor.batteries_state_of_capacity + battery_power_190: sensor.batteries_charge_discharge_power + battery_current_191: sensor.batteries_bus_current + battery_temp_182: sensor.batteries_temperature + battery_status: sensor.batteries_status + essential_power: sensor.house_consumption_power_less_aux_non_essential + essential_load1: sensor.lights_all_active_power + essential_load2: sensor.gpo_all_active_power_less_known + essential_load1_extra: null + essential_load2_extra: null + nonessential_power: sensor.sunsynk_card_non_essential_active_power + non_essential_load1: sensor.aircon_active_power + non_essential_load2: sensor.ev_charger_active_power + grid_power_169: sensor.house_consumption_power + grid_ct_power_172: sensor.power_meter_active_power + grid_ct_power_total: sensor.power_meter_active_power + grid_connected_status_194: sensor.inverters_off_grid_status + aux_power_166: sensor.sunsynk_card_aux_active_power + aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status + energy_cost_buy: sensor.electricity_price + energy_cost_sell: sensor.electricity_fit + solar_sell_247: switch.null + aux_load1: sensor.it_hardware_network_active_power + aux_load2: sensor.it_hardware_servers_active_power + aux_load1_extra: sensor.env_network_rack_bme280_temperature + aux_load2_extra: sensor.garage_controller_bme280_temperature + grid_voltage: sensor.power_meter_voltage + + + +************************************************************************************************ +Example 3 - 1 x M1 3phase inverter with a 15kWh LUNA ESS battery - 2 PV strings (10kW) +************************************************************************************************ + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + panel_mode: false + large_font: false + title: Huawei - Power Monitor + title_size: 18px + show_solar: true + show_grid: true + show_battery: true + decimal_places: 2 + dynamic_line_width: true + inverter: + modern: false + colour: grey + autarky: power + auto_scale: true + model: huawei + three_phase: true + battery: + energy: 14850 + shutdown_soc: sensor.battery_end_of_discharge_soc + invert_power: true + colour: '#fc8d83' + show_daily: true + animation_speed: 5 + max_power: 5000 + show_absolute: true + auto_scale: true + hide_soc: false + show_remaining_energy: true + dynamic_colour: true + linear_gradient: true + solar: + colour: '#F7BC00' + show_daily: true + mppts: 2 + animation_speed: 8 + max_power: 10000 + pv1_name: Inv1.S1 + pv2_name: Inv2.S1 + display_mode: 2 + auto_scale: true + load: + colour: magenta + show_daily: true + show_daily_aux: true + show_aux: true + invert_aux: false + show_absolute_aux: false + aux_name: Generator + aux_type: gen + aux_colour: '#5490c2' + aux_off_colour: brown + aux_loads: 2 + aux_load1_name: IT - Servers + aux_load2_name: IT - Network + aux_load1_icon: mdi:server-network + aux_load2_icon: mdi:network + animation_speed: 4 + essential_name: Essential + max_power: 4000 + additional_loads: 2 + load1_name: Lights + load2_name: All GPO + load3_name: Spare + load4_name: Spare + load1_icon: mdi:lightbulb + load2_icon: mdi:power-plug + load3_icon: mdi:water-boiler + load4_icon: mdi:kettle + auto_scale: true + dynamic_icon: true + dynamic_colour: true + grid: + grid_name: Your-Grid-Name + colour: '#FF2400' + export_colour: green + no_grid_colour: '#a40013' + grid_off_colour: '#e7d59f' + show_daily_buy: true + show_daily_sell: true + show_nonessential: true + invert_grid: true + nonessential_name: Non Essential + nonessential_icon: none + additional_loads: 2 + load1_name: HVAC + load2_name: EV + load1_icon: mdi:fan + load2_icon: mdi:car + animation_speed: 7 + max_power: 25000 + auto_scale: true + dynamic_icon: true + dynamic_colour: true + energy_cost_decimals: 3 + entities: + use_timer_248: null + priority_load_243: null + day_battery_charge_70: sensor.batteries_day_charge + day_battery_discharge_71: sensor.batteries_day_discharge + day_load_energy_84: sensor.house_consumption_energy_daily + day_grid_import_76: sensor.hs_grid_imported_daily + day_grid_export_77: sensor.hs_grid_exported_daily + day_pv_energy_108: sensor.inverters_daily_yield + day_aux_energy: sensor.sunsynk_card_aux_energy_daily + inverter_voltage_154: sensor.power_meter_phase_a_voltage + inverter_voltage_L2: sensor.power_meter_phase_b_voltage + inverter_voltage_L3: sensor.power_meter_phase_c_voltage + load_frequency_192: sensor.power_meter_frequency + grid_power_169: sensor.house_consumption_power + inverter_current_164: sensor.inverter_phase_a_current + inverter_current_L2: sensor.inverter_phase_b_current + inverter_current_L3: sensor.inverter_phase_c_current + inverter_power_175: sensor.inverters_active_power + inverter_status_59: sensor.inverters_state + radiator_temp_91: null + dc_transformer_temp_90: sensor.inverters_internal_temperature + pv1_power_186: sensor.inverter_1_pv_1_power + pv2_power_187: sensor.inverter_1_pv_2_power + pv_total: sensor.inverters_input_power + environment_temp: sensor._temp + remaining_solar: sensor.energy_production_today_remaining + pv1_voltage_109: sensor.inverter_pv_1_voltage + pv1_current_110: sensor.inverter_pv_1_current + pv2_voltage_111: sensor.inverter_pv_2_voltage + pv2_current_112: sensor.inverter_pv_2_current + battery_voltage_183: sensor.batteries_bus_voltage + battery_soc_184: sensor.batteries_state_of_capacity + battery_power_190: sensor.batteries_charge_discharge_power + battery_current_191: sensor.batteries_bus_current + battery_temp_182: sensor.batteries_temperature + battery_status: sensor.batteries_status + essential_power: sensor.house_consumption_power_less_aux_non_essential + essential_load1: sensor.lights_all_active_power + essential_load2: sensor.gpo_all_active_power_less_known + essential_load1_extra: null + essential_load2_extra: null + load_power_L1: sensor.shelly3em_phase_a_gpo_power + load_power_L2: sensor.shelly3em_phase_b_gpo_power + load_power_L3: sensor.shelly3em_phase_c_gpo_power + nonessential_power: sensor.sunsynk_card_non_essential_active_power + non_essential_load1: sensor.hvac_active_power + non_essential_load2: sensor.ev_charger_active_power + grid_ct_power_172: sensor.power_meter_phase_a_active_power + grid_ct_power_L2: sensor.power_meter_phase_b_active_power + grid_ct_power_L3: sensor.power_meter_phase_c_active_power + grid_ct_power_total: sensor.power_meter_active_power + grid_connected_status_194: sensor.inverters_off_grid_status + aux_power_166: sensor.sunsynk_card_aux_active_power + aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status + energy_cost_buy: sensor.electricity_price + energy_cost_sell: sensor.electricity_fit + solar_sell_247: switch.null + aux_load1: sensor.it_hardware_network_active_power + aux_load2: sensor.it_hardware_servers_active_power + aux_load1_extra: sensor.env_network_rack_bme280_temperature + aux_load2_extra: sensor.garage_controller_bme280_temperature + grid_voltage: sensor.power_meter_voltage + + + +*************************************************************************************************** +Example 4 - 1 x M1 3phase inverters with 2 x 15kWh LUNA ESS batteries - 2 PV strings (10kW) +*************************************************************************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + panel_mode: false + large_font: false + title: Huawei - Power Monitor + title_size: 18px + show_solar: true + show_grid: true + show_battery: true + decimal_places: 2 + dynamic_line_width: true + inverter: + modern: false + colour: grey + autarky: power + auto_scale: true + model: huawei + three_phase: true + battery: + energy: 29700 + shutdown_soc: sensor.battery_end_of_discharge_soc + invert_power: true + colour: '#fc8d83' + show_daily: true + animation_speed: 5 + max_power: 10000 + show_absolute: true + auto_scale: true + hide_soc: false + show_remaining_energy: true + dynamic_colour: true + linear_gradient: true + solar: + colour: '#F7BC00' + show_daily: true + mppts: 2 + animation_speed: 8 + max_power: 10000 + pv1_name: Inv1.S1 + pv2_name: Inv2.S1 + display_mode: 2 + auto_scale: true + load: + colour: magenta + show_daily: true + show_daily_aux: true + show_aux: true + invert_aux: false + show_absolute_aux: false + aux_name: Generator + aux_type: gen + aux_colour: '#5490c2' + aux_off_colour: brown + aux_loads: 2 + aux_load1_name: IT - Servers + aux_load2_name: IT - Network + aux_load1_icon: mdi:server-network + aux_load2_icon: mdi:network + animation_speed: 4 + essential_name: Essential + max_power: 4000 + additional_loads: 2 + load1_name: Lights + load2_name: All GPO + load3_name: Spare + load4_name: Spare + load1_icon: mdi:lightbulb + load2_icon: mdi:power-plug + load3_icon: mdi:water-boiler + load4_icon: mdi:kettle + auto_scale: true + dynamic_icon: true + dynamic_colour: true + grid: + grid_name: Your-Grid-Name + colour: '#FF2400' + export_colour: green + no_grid_colour: '#a40013' + grid_off_colour: '#e7d59f' + show_daily_buy: true + show_daily_sell: true + show_nonessential: true + invert_grid: true + nonessential_name: Non Essential + nonessential_icon: none + additional_loads: 2 + load1_name: HVAC + load2_name: EV + load1_icon: mdi:fan + load2_icon: mdi:car + animation_speed: 7 + max_power: 25000 + auto_scale: true + dynamic_icon: true + dynamic_colour: true + energy_cost_decimals: 3 + entities: + use_timer_248: null + priority_load_243: null + day_battery_charge_70: sensor.batteries_day_charge + day_battery_discharge_71: sensor.batteries_day_discharge + day_load_energy_84: sensor.house_consumption_energy_daily + day_grid_import_76: sensor.hs_grid_imported_daily + day_grid_export_77: sensor.hs_grid_exported_daily + day_pv_energy_108: sensor.inverters_daily_yield + day_aux_energy: sensor.sunsynk_card_aux_energy_daily + inverter_voltage_154: sensor.power_meter_phase_a_voltage + inverter_voltage_L2: sensor.power_meter_phase_b_voltage + inverter_voltage_L3: sensor.power_meter_phase_c_voltage + load_frequency_192: sensor.power_meter_frequency + grid_power_169: sensor.house_consumption_power + inverter_current_164: sensor.inverter_phase_a_current + inverter_current_L2: sensor.inverter_phase_b_current + inverter_current_L3: sensor.inverter_phase_c_current + inverter_power_175: sensor.inverters_active_power + inverter_status_59: sensor.inverters_state + radiator_temp_91: null + dc_transformer_temp_90: sensor.inverters_internal_temperature + pv1_power_186: sensor.inverter_1_pv_1_power + pv2_power_187: sensor.inverter_1_pv_2_power + pv3_power_188: sensor.inverter_2_pv_1_power + pv4_power_189: sensor.inverter_2_pv_2_power + pv_total: sensor.inverters_input_power + environment_temp: sensor._temp + remaining_solar: sensor.energy_production_today_remaining + pv1_voltage_109: sensor.inverter_pv_1_voltage + pv1_current_110: sensor.inverter_pv_1_current + pv2_voltage_111: sensor.inverter_pv_2_voltage + pv2_current_112: sensor.inverter_pv_2_current + battery_voltage_183: sensor.batteries_bus_voltage + battery_soc_184: sensor.batteries_state_of_capacity + battery_power_190: sensor.batteries_charge_discharge_power + battery_current_191: sensor.batteries_bus_current + battery_temp_182: sensor.batteries_temperature + battery_status: sensor.batteries_status + essential_power: sensor.house_consumption_power_less_aux_non_essential + essential_load1: sensor.lights_all_active_power + essential_load2: sensor.gpo_all_active_power_less_known + essential_load1_extra: null + essential_load2_extra: null + load_power_L1: sensor.shelly3em_phase_a_gpo_power + load_power_L2: sensor.shelly3em_phase_b_gpo_power + load_power_L3: sensor.shelly3em_phase_c_gpo_power + nonessential_power: sensor.sunsynk_card_non_essential_active_power + non_essential_load1: sensor.hvac_active_power + non_essential_load2: sensor.ev_charger_active_power + grid_ct_power_172: sensor.power_meter_phase_a_active_power + grid_ct_power_L2: sensor.power_meter_phase_b_active_power + grid_ct_power_L3: sensor.power_meter_phase_c_active_power + grid_ct_power_total: sensor.power_meter_active_power + grid_connected_status_194: sensor.inverters_off_grid_status + aux_power_166: sensor.sunsynk_card_aux_active_power + aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status + energy_cost_buy: sensor.electricity_price + energy_cost_sell: sensor.electricity_fit + solar_sell_247: switch.null + aux_load1: sensor.it_hardware_network_active_power + aux_load2: sensor.it_hardware_servers_active_power + aux_load1_extra: sensor.env_network_rack_bme280_temperature + aux_load2_extra: sensor.garage_controller_bme280_temperature + grid_voltage: sensor.power_meter_voltage + + +*************************************************************************************************** +Example 5 - 2 x M1 3phase inverters with a 15kWh LUNA ESS battery - 4 PV strings (20kW) +*************************************************************************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + panel_mode: false + large_font: false + title: Huawei - Power Monitor + title_size: 18px + show_solar: true + show_grid: true + show_battery: true + decimal_places: 2 + dynamic_line_width: true + inverter: + modern: false + colour: grey + autarky: power + auto_scale: true + model: huawei + three_phase: true + battery: + energy: 14850 + shutdown_soc: sensor.battery_end_of_discharge_soc + invert_power: true + colour: '#fc8d83' + show_daily: true + animation_speed: 5 + max_power: 5000 + show_absolute: true + auto_scale: true + hide_soc: false + show_remaining_energy: true + dynamic_colour: true + linear_gradient: true + solar: + colour: '#F7BC00' + show_daily: true + mppts: 4 + animation_speed: 8 + max_power: 20000 + pv1_name: Inv1.S1 + pv2_name: Inv2.S1 + pv3_name: Inv1.S2 + pv4_name: Inv2.S2 + display_mode: 2 + auto_scale: true + load: + colour: magenta + show_daily: true + show_daily_aux: true + show_aux: true + invert_aux: false + show_absolute_aux: false + aux_name: Generator + aux_type: gen + aux_colour: '#5490c2' + aux_off_colour: brown + aux_loads: 2 + aux_load1_name: IT - Servers + aux_load2_name: IT - Network + aux_load1_icon: mdi:server-network + aux_load2_icon: mdi:network + animation_speed: 4 + essential_name: Essential + max_power: 4000 + additional_loads: 2 + load1_name: Lights + load2_name: All GPO + load3_name: Spare + load4_name: Spare + load1_icon: mdi:lightbulb + load2_icon: mdi:power-plug + load3_icon: mdi:water-boiler + load4_icon: mdi:kettle + auto_scale: true + dynamic_icon: true + dynamic_colour: true + grid: + grid_name: Your-Grid-Name + colour: '#FF2400' + export_colour: green + no_grid_colour: '#a40013' + grid_off_colour: '#e7d59f' + show_daily_buy: true + show_daily_sell: true + show_nonessential: true + invert_grid: true + nonessential_name: Non Essential + nonessential_icon: none + additional_loads: 2 + load1_name: HVAC + load2_name: EV + load1_icon: mdi:fan + load2_icon: mdi:car + animation_speed: 7 + max_power: 25000 + auto_scale: true + dynamic_icon: true + dynamic_colour: true + energy_cost_decimals: 3 + entities: + use_timer_248: null + priority_load_243: null + day_battery_charge_70: sensor.batteries_day_charge + day_battery_discharge_71: sensor.batteries_day_discharge + day_load_energy_84: sensor.house_consumption_energy_daily + day_grid_import_76: sensor.hs_grid_imported_daily + day_grid_export_77: sensor.hs_grid_exported_daily + day_grid_export_77: sensor.hs_grid_exported_daily + day_grid_export_77: sensor.hs_grid_exported_daily + day_pv_energy_108: sensor.inverters_daily_yield + day_aux_energy: sensor.sunsynk_card_aux_energy_daily + inverter_voltage_154: sensor.power_meter_phase_a_voltage + inverter_voltage_L2: sensor.power_meter_phase_b_voltage + inverter_voltage_L3: sensor.power_meter_phase_c_voltage + load_frequency_192: sensor.power_meter_frequency + grid_power_169: sensor.house_consumption_power + inverter_current_164: sensor.inverter_phase_a_current + inverter_current_L2: sensor.inverter_phase_b_current + inverter_current_L3: sensor.inverter_phase_c_current + inverter_power_175: sensor.inverters_active_power + inverter_status_59: sensor.inverters_state + radiator_temp_91: null + dc_transformer_temp_90: sensor.inverters_internal_temperature + pv1_power_186: sensor.inverter_1_pv_1_power + pv2_power_187: sensor.inverter_1_pv_2_power + pv3_power_188: sensor.inverter_2_pv_1_power + pv4_power_189: sensor.inverter_2_pv_2_power + pv_total: sensor.inverters_input_power + environment_temp: sensor._temp + remaining_solar: sensor.energy_production_today_remaining + pv1_voltage_109: sensor.inverter_pv_1_voltage + pv1_current_110: sensor.inverter_pv_1_current + pv2_voltage_111: sensor.inverter_pv_2_voltage + pv2_current_112: sensor.inverter_pv_2_current + pv3_voltage_113: sensor.inverter_pv_1_voltage_2 + pv3_current_114: sensor.inverter_pv_1_current_2 + pv4_voltage_115: sensor.inverter_pv_2_voltage_2 + pv4_current_116: sensor.inverter_pv_2_current_2 + battery_voltage_183: sensor.batteries_bus_voltage + battery_soc_184: sensor.batteries_state_of_capacity + battery_power_190: sensor.batteries_charge_discharge_power + battery_current_191: sensor.batteries_bus_current + battery_temp_182: sensor.batteries_temperature + battery_status: sensor.batteries_status + essential_power: sensor.house_consumption_power_less_aux_non_essential + essential_load1: sensor.lights_all_active_power + essential_load2: sensor.gpo_all_active_power_less_known + essential_load1_extra: null + essential_load2_extra: null + load_power_L1: sensor.shelly3em_phase_a_gpo_power + load_power_L2: sensor.shelly3em_phase_b_gpo_power + load_power_L3: sensor.shelly3em_phase_c_gpo_power + nonessential_power: sensor.sunsynk_card_non_essential_active_power + non_essential_load1: sensor.hvac_active_power + non_essential_load2: sensor.ev_charger_active_power + grid_ct_power_172: sensor.power_meter_phase_a_active_power + grid_ct_power_L2: sensor.power_meter_phase_b_active_power + grid_ct_power_L3: sensor.power_meter_phase_c_active_power + grid_ct_power_total: sensor.power_meter_active_power + grid_connected_status_194: sensor.inverters_off_grid_status + aux_power_166: sensor.sunsynk_card_aux_active_power + aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status + energy_cost_buy: sensor.electricity_price + energy_cost_sell: sensor.electricity_fit + solar_sell_247: switch.null + aux_load1: sensor.it_hardware_network_active_power + aux_load2: sensor.it_hardware_servers_active_power + aux_load1_extra: sensor.env_network_rack_bme280_temperature + aux_load2_extra: sensor.garage_controller_bme280_temperature + grid_voltage: sensor.power_meter_voltage diff --git a/_sources/examples/lux.rst.txt b/_sources/examples/lux.rst.txt new file mode 100644 index 00000000..7c04a99b --- /dev/null +++ b/_sources/examples/lux.rst.txt @@ -0,0 +1,134 @@ +############## +Lux Inverter +############## + +********* +Example 1 +********* + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: lite + show_solar: true + inverter: + model: lux + battery: + show: true + energy: 12800 + shutdown_soc: 1 + show_daily: true + invert_power: true + solar: + show_daily: true + mppts: 2 + pv1_name: Rear + pv2_name: Front + load: + show_daily: true + grid: + show_daily_buy: true + show_daily_sell: true + show_nonessential: false + invert_grid: true + additional_loads: 2 + entities: + inverter_voltage_154: sensor.lux_grid_voltage_live + load_frequency_192: sensor.lux_grid_frequency_live + inverter_current_164: sensor.inverter_output_current + inverter_status_59: sensor.lux_status + inverter_power_175: sensor.lux_battery_flow_live + day_battery_charge_70: sensor.lux_battery_charge_daily + day_battery_discharge_71: sensor.lux_battery_discharge_daily + battery_voltage_183: sensor.lux_battery_voltage_live + battery_soc_184: sensor.lux_battery + battery_power_190: sensor.lux_battery_flow_live + battery_current_191: sensor.lux_battery_capacity_ah + grid_power_169: sensor.lux_grid_flow_live + day_grid_import_76: sensor.lux_power_from_grid_daily + day_grid_export_77: sensor.lux_power_to_grid_daily + grid_ct_power_172: sensor.lux_grid_flow_live + day_load_energy_84: sensor.lux_power_from_inverter_to_home_daily + essential_power: sensor.lux_home_consumption_live + nonessential_power: none + aux_power_166: sensor.aux_output_power + day_pv_energy_108: sensor.lux_solar_output_daily + pv_total: sensor.lux_solar_output_live + pv1_power_186: sensor.lux_solar_output_array_1_live + pv2_power_187: sensor.lux_solar_output_array_2_live + pv1_voltage_109: sensor.lux_solar_voltage_array_1_live + pv1_current_110: none + pv2_voltage_111: sensor.lux_solar_voltage_array_2_live + pv2_current_112: none + radiator_temp_91: sensor.lux_radiator_1_temperature_live + dc_transformer_temp_90: sensor.lux_radiator_2_temperature_live + remaining_solar: sensor.forecast_remaining_today + energy_cost: sensor.octopus_energy_electricity_20e5081533_2380002009185_current_rate + +************************************************************************************ +Example 2 using the lxp-bridge integration (https://github.com/celsworth/lxp-bridge) +************************************************************************************ + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: lite + show_solar: true + inverter: + model: lux + battery: + energy: 12800 + shutdown_soc: 20 + show_daily: true + invert_power: true + solar: + show_daily: true + mppts: 2 + pv1_name: PV1 + pv2_name: PV2 + load: + show_daily: true + grid: + show_daily_buy: true + show_daily_sell: true + show_nonessential: false + invert_grid: true + additional_loads: 0 + entities: + inverter_voltage_154: sensor.lxp_baXXXXXXXX_grid_voltage + load_frequency_192: sensor.lxp_baXXXXXXXX_eps_frequency + inverter_current_164: NONE + inverter_status_59: NONE + inverter_power_175: sensor.lxp_baXXXXXXXX_inverter_power + day_battery_charge_70: sensor.lxp_baXXXXXXXX_battery_charge_today + day_battery_discharge_71: sensor.lxp_baXXXXXXXX_battery_discharge_today + battery_voltage_183: sensor.lxp_baXXXXXXXX_battery_voltage + battery_soc_184: sensor.lxp_baXXXXXXXX_battery_percentage + battery_power_190: sensor.lxp_baXXXXXXXX_battery_power_discharge_is_negative + battery_current_191: NONE + grid_power_169: sensor.lxp_baXXXXXXXX_grid_power_export_is_negative + day_grid_import_76: sensor.lxp_baXXXXXXXX_energy_from_grid_today + day_grid_export_77: sensor.lxp_baXXXXXXXX_energy_to_grid_today + grid_ct_power_172: NONE + day_load_energy_84: sensor.lxp_baXXXXXXXX_energy_of_inverter_today + essential_power: sensor.lxp_baXXXXXXXX_inverter_power + nonessential_power: NONE + aux_power_166: NONE + day_pv_energy_108: sensor.lxp_baXXXXXXXX_pv_generation_today + pv_total: sensor.lxp_baXXXXXXXX_power_pv_array + pv1_power_186: sensor.lxp_baXXXXXXXX_power_pv_string_1 + pv2_power_187: sensor.lxp_baXXXXXXXX_power_pv_string_2 + pv1_voltage_109: sensor.lxp_baXXXXXXXX_voltage_pv_string_1 + pv1_current_110: NONE + pv2_voltage_111: sensor.lxp_baXXXXXXXX_voltage_pv_string_2 + pv2_current_112: NONE + radiator_temp_91: sensor.lxp_baXXXXXXXX_radiator_1_temperature + dc_transformer_temp_90: sensor.lxp_baXXXXXXXX_radiator_2_temperature + remaining_solar: sensor.forecast_remaining_today + energy_cost: NONE + +.. note:: + + Replace ``baXXXXXXXX`` with your wifi dongle number \ No newline at end of file diff --git a/_sources/examples/solax.rst.txt b/_sources/examples/solax.rst.txt new file mode 100644 index 00000000..bedec0fd --- /dev/null +++ b/_sources/examples/solax.rst.txt @@ -0,0 +1,90 @@ +################ +SolaX Inverter +################ + +****************************************************************************************** +Example 1 +****************************************************************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: compact + show_solar: true + show_grid: true + show_battery: true + large_font: false + panel_mode: false + inverter: + auto_scale: false + modern: false + model: solax + battery: + energy: 17600 + shutdown_soc: 11 + show_daily: true + invert_power: true + max_power: 3750 + auto_scale: false + show_absolute: false + hide_soc: false + solar: + show_daily: true + mppts: 1 + max_power: 7000 + display_mode: 2 + animation_speed: 9 + dynamic_colour: false + load: + show_daily: true + max_power: 15000 + show_aux: false + show_nonessential: true + additional_loads: 2 + load1_name: Water + load2_name: EV + load1_icon: mdi:thermometer-water + load2_icon: mdi:ev-station + animation_speed: 9 + grid: + show_daily_buy: true + show_daily_sell: true + show_nonessential: false + animation_speed: 9 + auto_scale: false + export_colour: + - 194 + - 6 + - 219 + no_grid_colour: + - 189 + - 188 + - 188 + entities: + inverter_status_59: sensor.solax_run_mode + inverter_voltage_154: sensor.solax_inverter_voltage + inverter_current_164: sensor.solax_inverter_current + inverter_power_175: sensor.solax_inverter_power + radiator_temp_91: sensor.solax_inverter_temperature + day_battery_charge_70: sensor.solax_battery_input_energy_today + day_battery_discharge_71: sensor.solax_battery_output_energy_today + battery_voltage_183: sensor.solax_battery_voltage_charge + battery_soc_184: sensor.solax_battery_capacity + battery_power_190: sensor.solax_battery_power_charge + battery_current_191: sensor.solax_battery_current_charge + battery_temp_182: sensor.solax_battery_temperature + day_grid_import_76: sensor.solax_today_s_import_energy + day_grid_export_77: sensor.solax_today_s_export_energy + grid_power_169: sensor.solax_grid_export_import_sum2 + grid_ct_power_172: sensor.solax_grid_export_import_sum2 + day_load_energy_84: sensor.powerflow_today_house_load + day_pv_energy_108: sensor.solax_today_s_solar_energy + pv1_power_186: sensor.solax_pv_power_1 + pv1_voltage_109: sensor.solax_pv_voltage_1 + pv1_current_110: sensor.solax_pv_current_1 + remaining_solar: sensor.solcast_pv_forecast_forecast_remaining_today + essential_load1: sensor.immersion_current_consumption + essential_load1_extra: sensor.immersion_energy_day + essential_load2: sensor.ev_power_consumption + essential_load2_extra: sensor.ev_fast_charge_day diff --git a/_sources/examples/solis.rst.txt b/_sources/examples/solis.rst.txt new file mode 100644 index 00000000..06336327 --- /dev/null +++ b/_sources/examples/solis.rst.txt @@ -0,0 +1,200 @@ +################ +Solis Inverter +################ + +****************************************************************************************** +Example 1 - Integration via https://github.com/wills106/homeassistant-solax-modbus +****************************************************************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: lite + show_solar: true + large_font: true + inverter: + modern: true + autarky: energy + battery: + energy: 14400 + shutdown_soc: 20 + show_daily: true + solar: + show_daily: true + mppts: 1 + load: + show_daily: true + additional_loads: 2 + load1_name: PC + load1_icon: mdi:desktop-classic + load2_name: TV + load2_icon: mdi:television + grid: + show_daily_buy: true + show_daily_sell: true + show_nonessential: false + entities: + grid_power_167: sensor.solis_inverter_meter_active_power + essential_power: sensor.solis_inverter_house_load + essential_load1: sensor.pc_socket_power + essential_load2: sensor.smart_socket_3_power + energy_cost_buy: sensor.octopus_energy_electricity_xxxxx_xxxxxx_current_rate + energy_cost_sell: sensor.octopus_energy_electricity_xxxxxx_xxxxx_export_current_rate + remaining_solar: sensor.energy_production_today_remaining + radiator_temp_91: sensor.solis_inverter_inverter_temperature + use_timer_248: switch.sunsynk_toggle_system_timer + inverter_voltage_154: sensor.solis_inverter_inverter_voltage + load_frequency_192: sensor.solis_inverter_inverter_frequency + inverter_current_164: sensor.solis_inverter_inverter_current + inverter_power_175: sensor.solis_inverter_active_power + day_battery_charge_70: sensor.solis_inverter_battery_charge_today + day_battery_discharge_71: sensor.solis_inverter_battery_discharge_today + battery_voltage_183: sensor.solis_inverter_battery_voltage + battery_soc_184: sensor.solis_inverter_battery_soc + battery_power_190: sensor.battery_load + battery_current_191: sensor.solis_inverter_battery_current + day_grid_import_76: sensor.solis_inverter_grid_import_today + day_grid_export_77: sensor.solis_inverter_grid_export_today + grid_ct_power_172: sensor.solis_inverter_meter_active_power + day_load_energy_84: sensor.solis_inverter_house_load_today + day_pv_energy_108: sensor.solis_inverter_power_generation_today + pv1_power_186: sensor.solis_inverter_pv_total_power + pv1_voltage_109: sensor.solis_inverter_pv_voltage_1 + pv1_current_110: sensor.solis_inverter_pv_current_1 +****************************************************************************************** +Example 2 (Solis S6 or S2-WL-ST) - Integration via https://github.com/Pho3niX90/solis_modbus +****************************************************************************************** +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + view_layout: + grid-area: flow + cardstyle: lite + large_font: true + show_solar: true + panel_mode: true + card_height: 415px + inverter: + model: solis + modern: false + colour: '#959595' + autarky: 'no' + solar: + mppts: 2 + show_daily: false + colour: '#F4C430' + animation_speed: 9 + max_power: 9600 + pv1_name: West + pv2_name: North + battery: + energy: 14280 + shutdown_soc: 20 + show_daily: true + colour: pink + animation_speed: 6 + max_power: 6000 + load: + show_aux: false + show_daily: true + animation_speed: 8 + max_power: 6000 + additional_loads: 2 + load2_name: Geyser + load2_icon: mdi:heating-coil + load1_name: Pool + load1_icon: mdi:pool + grid: + show_daily_buy: true + no_grid_colour: red + animation_speed: 8 + max_power: 6000 + invert_grid: true + entities: + dc_transformer_temp_90: sensor.solis_inverter_temperature + day_battery_charge_70: sensor.solis_inverter_today_battery_charge_energy + day_battery_discharge_71: sensor.solis_inverter_today_battery_discharge_energy + day_load_energy_84: sensor.solis_inverter_today_energy_consumption + day_grid_import_76: sensor.solis_inverter_today_energy_imported_from_grid + day_grid_export_77: sensor.solis_inverter_today_energy_fed_into_grid + day_pv_energy_108: sensor.solis_inverter_pv_today_energy_generation + inverter_voltage_154: sensor.solis_inverter_a_phase_voltage + load_frequency_192: sensor.solis_inverter_grid_frequency + inverter_current_164: sensor.solis_inverter_a_phase_current + inverter_power_175: sensor.solis_inverter_backup_load_power + grid_power_169: sensor.solis_inverter_ac_grid_port_power + battery_voltage_183: sensor.solis_inverter_battery_voltage + battery_soc_184: sensor.solis_inverter_battery_soc + battery_power_190: sensor.solis_inverter_battery_power + battery_current_191: sensor.solis_inverter_battery_current + essential_power: sensor.solis_inverter_backup_load_power + grid_ct_power_172: sensor.solis_inverter_meter_total_active_power + pv1_voltage_109: sensor.solis_inverter_dc_voltage_1 + pv1_current_110: sensor.solis_inverter_dc_current_1 + pv1_power_186: sensor.solis_inverter_dc_power_1 + pv2_voltage_111: sensor.solis_inverter_dc_voltage_2 + pv2_current_112: sensor.solis_inverter_dc_current_2 + pv2_power_187: sensor.solis_inverter_dc_power_2 + pv_total: sensor.solis_inverter_total_dc_output + grid_voltage: sensor.solis_inverter_a_phase_voltage + battery_current_direction: sensor.solis_inverter_battery_current_direction + inverter_status_59: sensor.solis_inverter_current_status + remaining_solar: sensor.solcast_pv_forecast_forecast_remaining_today + +****************************************************************************************** +Example 3 (Solis S6 or S2-WL-ST) - Integration via https://github.com/fboundy/ha_solis_modbus +****************************************************************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + show_solar: true + inverter: + model: solis + battery: + energy: 54 + shutdown_soc: 20 + show_daily: true + solar: + show_daily: true + mppts: 2 + load: + show_daily: true + grid: + show_daily_buy: true + show_daily_sell: false + show_nonessential: false + entities: + inverter_voltage_154: sensor.solis_inverter_voltage + load_frequency_192: sensor.solis_inverter_frequency + inverter_current_164: sensor.solis_inverter_current + inverter_power_175: sensor.solis_inverter_ac_power + grid_connected_status_194: null + grid_voltage: sensor.solis_grid_voltage + inverter_status_59: sensor.solis_inverter_status + day_battery_charge_70: none + day_battery_discharge_71: none + battery_voltage_183: sensor.solis_battery_voltage + battery_soc_184: sensor.solis_battery_soc_lead + battery_power_190: sensor.solis_battery_power + battery_current_191: sensor.solis_battery_current + battery_current_direction: sensor.solis_battery_current_direction + grid_power_169: sensor.solis_grid_active_power_negative + day_grid_import_76: sensor.solis_daily_energy_imported + day_grid_export_77: sensor.solis_daily_energy_exported + grid_ct_power_172: sensor.solis_grid_active_power_negative + day_load_energy_84: sensor.solis_daily_consumption + essential_power: sensor.solis_backup_load_power + nonessential_power: none + aux_power_166: none + day_pv_energy_108: none + pv1_power_186: none + pv2_power_187: none + pv1_voltage_109: sensor.solis_pv1_voltage + pv1_current_110: sensor.solis_pv1_current + pv2_voltage_111: sensor.solis_pv2_voltage + pv2_current_112: sensor.solis_pv2_current diff --git a/_sources/examples/sunsynk.rst.txt b/_sources/examples/sunsynk.rst.txt new file mode 100644 index 00000000..0dd9c268 --- /dev/null +++ b/_sources/examples/sunsynk.rst.txt @@ -0,0 +1,365 @@ +################# +Sunsynk Inverter +################# + + +******************************** +Minimum Configuration (No Solar, No Battery) +******************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + show_solar: false + show_battery: false + entities: + inverter_power_175: sensor.sunsynk_inverter_power + grid_power_169: sensor.sunsynk_grid_power + battery_soc_184: sensor.sunsynk_battery_soc + battery_power_190: sensor.sunsynk_battery_power + battery_current_191: sensor.sunsynk_battery_current + grid_ct_power_172: sensor.sunsynk_grid_ct_power + + +***************************** +Minimum Configuration (Solar) +***************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + solar: + mppts: 1 + battery: + energy: 15960 + shutdown_soc: 20 + entities: + inverter_power_175: sensor.sunsynk_inverter_power + grid_power_169: sensor.sunsynk_grid_power + battery_soc_184: sensor.sunsynk_battery_soc + battery_power_190: sensor.sunsynk_battery_power + battery_current_191: sensor.sunsynk_battery_current + grid_ct_power_172: sensor.sunsynk_grid_ct_power + pv1_power_186: sensor.sunsynk_pv1_power + +***************************** +Minimal Configuration (No Solar) +***************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + show_solar: false + battery: + energy: 15960 + shutdown_soc: 20 + entities: + inverter_voltage_154: sensor.sunsynk_inverter_voltage + load_frequency_192: sensor.sunsynk_load_frequency + inverter_current_164: sensor.sunsynk_inverter_current + inverter_power_175: sensor.sunsynk_inverter_power + grid_power_169: sensor.sunsynk_grid_power + battery_voltage_183: sensor.sunsynk_battery_voltage + battery_soc_184: sensor.sunsynk_battery_soc + battery_power_190: sensor.sunsynk_battery_power + battery_current_191: sensor.sunsynk_battery_current + grid_ct_power_172: sensor.sunsynk_grid_ct_power + grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status + inverter_status_59: sensor.overall_state + +***************************** +Minimal Configuration (No Battery) +***************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + show_battery: false + entities: + inverter_voltage_154: sensor.sunsynk_inverter_voltage + load_frequency_192: sensor.sunsynk_load_frequency + inverter_current_164: sensor.sunsynk_inverter_current + inverter_power_175: sensor.sunsynk_inverter_power + grid_power_169: sensor.sunsynk_grid_power + battery_voltage_183: sensor.sunsynk_battery_voltage + battery_soc_184: sensor.sunsynk_battery_soc + battery_power_190: sensor.sunsynk_battery_power + battery_current_191: sensor.sunsynk_battery_current + grid_ct_power_172: sensor.sunsynk_grid_ct_power + grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status + inverter_status_59: sensor.overall_state + +***************************** +Minimal Configuration (Solar and Battery) +***************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + solar: + mppts: 2 + battery: + energy: 15960 + shutdown_soc: 20 + load: + show_aux: false + entities: + inverter_voltage_154: sensor.sunsynk_inverter_voltage + load_frequency_192: sensor.sunsynk_load_frequency + inverter_current_164: sensor.sunsynk_inverter_current + inverter_power_175: sensor.sunsynk_inverter_power + grid_power_169: sensor.sunsynk_grid_power + battery_voltage_183: sensor.sunsynk_battery_voltage + battery_soc_184: sensor.sunsynk_battery_soc + battery_power_190: sensor.sunsynk_battery_power + battery_current_191: sensor.sunsynk_battery_current + grid_ct_power_172: sensor.sunsynk_grid_ct_power + grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status + inverter_status_59: sensor.sunsynk_overall_state + pv1_power_186: sensor.sunsynk_pv1_power + pv2_power_187: sensor.sunsynk_pv2_power + pv1_voltage_109: sensor.sunsynk_pv1_voltage + pv1_current_110: sensor.sunsynk_pv1_current + pv2_voltage_111: sensor.sunsynk_pv2_voltage + pv2_current_112: sensor.sunsynk_pv2_current + +******************************************** +Minimal Configuration (Solar + Daily Totals) +******************************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + solar: + mppts: 2 + show_daily: true + battery: + energy: 15960 + shutdown_soc: 20 + show_daily: true + load: + show_daily: true + grid: + show_daily_buy: true + entities: + inverter_voltage_154: sensor.sunsynk_inverter_voltage + load_frequency_192: sensor.sunsynk_load_frequency + inverter_current_164: sensor.sunsynk_inverter_current + inverter_power_175: sensor.sunsynk_inverter_power + grid_power_169: sensor.sunsynk_grid_power + battery_voltage_183: sensor.sunsynk_battery_voltage + battery_soc_184: sensor.sunsynk_battery_soc + battery_power_190: sensor.sunsynk_battery_power + battery_current_191: sensor.sunsynk_battery_current + grid_ct_power_172: sensor.sunsynk_grid_ct_power + grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status + inverter_status_59: sensor.sunsynk_overall_state + pv1_power_186: sensor.sunsynk_pv1_power + pv2_power_187: sensor.sunsynk_pv2_power + pv1_voltage_109: sensor.sunsynk_pv1_voltage + pv1_current_110: sensor.sunsynk_pv1_current + pv2_voltage_111: sensor.sunsynk_pv2_voltage + pv2_current_112: sensor.sunsynk_pv2_current + day_pv_energy_108: sensor.sunsynk_day_pv_energy + day_battery_charge_70: sensor.sunsynk_day_battery_charge + day_battery_discharge_71: sensor.sunsynk_day_battery_discharge + day_load_energy_84: sensor.sunsynk_day_load_energy + day_grid_import_76: sensor.sunsynk_day_grid_import + +******************************** +Full Configuration (All Options) +******************************** + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + panel_mode: false + large_font: false + title: Sunsynk Inverter + title_colour: grey + title_size: 32px + show_solar: true + show_battery: true + show_grid: true + decimal_places: 2 + dynamic_line_width: true + min_line_width: 1 + max_line_width: 4 + inverter: + modern: true + colour: grey + autarky: 'power' + auto_scale: true + three_phase: false + battery: + energy: 15960 + shutdown_soc: 20 + invert_power: false + colour: pink + show_daily: true + animation_speed: 6 + max_power: 4500 + show_absolute: false + auto_scale: true + hide_soc: false + dynamic_colour: true + linear_gradient: true + solar: + colour: orange + show_daily: true + mppts: 2 + animation_speed: 9 + max_power: 8000 + pv1_name: North + pv2_name: North + pv3_name: East + pv4_name: West + auto_scale: true + display_mode: 1 + dynamic_colour: true + load: + colour: '#5fb6ad' + show_daily: true + show_daily_aux: true + show_aux: true + invert_aux: false + show_absolute_aux: false + aux_name: Generator + aux_type: gen + aux_colour: green + aux_off_colour: red + aux_loads: 2 + aux_load1_name: Aux load 1 + aux_load2_name: Aux load 2 + aux_load1_icon: mdi:air-filter + aux_load2_icon: mdi:stove + animation_speed: 8 + max_power: 8000 + additional_loads: 2 + load1_name: Geyser + load2_name: Pool + load1_icon: boiler + load2_icon: mdi:pool + auto_scale: true + dynamic_colour: true + grid: + colour: '#5490c2' + export_colour: brown + grid_off_colour: red + show_daily_buy: true + show_daily_sell: true + no_grid_colour: '#a40013' + show_nonessential: true + invert_grid: false + nonessential_name: Non Essential + nonessential_icon: oven + additional_loads: 2 + load1_name: Load 1 + load2_name: Load 2 + load1_icon: boiler + load2_icon: mdi:ev-station + animation_speed: 8 + max_power: 8000 + auto_scale: true + entities: + use_timer_248: switch.sunsynk_toggle_system_timer + priority_load_243: switch.sunsynk_toggle_priority_load + day_battery_charge_70: sensor.sunsynk_day_battery_charge + day_battery_discharge_71: sensor.sunsynk_day_battery_discharge + day_load_energy_84: sensor.sunsynk_day_load_energy + day_grid_import_76: sensor.sunsynk_day_grid_import + day_grid_export_77: sensor.sunsynk_day_grid_export + day_pv_energy_108: sensor.sunsynk_day_pv_energy + day_aux_energy: sensor.sunsynk_day_aux_energy + inverter_voltage_154: sensor.sunsynk_inverter_voltage + inverter_voltage_L2: null + inverter_voltage_L3: null + load_frequency_192: sensor.sunsynk_load_frequency + inverter_current_164: sensor.sunsynk_inverter_current + inverter_current_L2: null + inverter_current_L3: null + inverter_power_175: sensor.sunsynk_inverter_power + grid_power_169: sensor.sunsynk_grid_power + pv1_power_186: sensor.sunsynk_pv1_power + pv2_power_187: sensor.sunsynk_pv2_power + pv3_power_188: none + pv4_power_189: none + pv_total: sensor.sunsynk_totalsolar + pv1_voltage_109: sensor.sunsynk_pv1_voltage + pv1_current_110: sensor.sunsynk_pv1_current + pv2_voltage_111: sensor.sunsynk_pv2_voltage + pv2_current_112: sensor.sunsynk_pv2_current + pv3_voltage_113: none + pv3_current_114: none + pv4_voltage_115: none + pv4_current_116: none + battery_voltage_183: sensor.sunsynk_battery_voltage + battery_soc_184: sensor.sunsynk_battery_soc + battery_power_190: sensor.sunsynk_battery_power + battery_current_191: sensor.sunsynk_battery_current + essential_power: none + essential_load1: sensor.tuya_geyser_current_consumption + essential_load2: sensor.load2_power + essential_load1_extra: sensor.daily_geyser_energy + essential_load2_extra: sensor.load2_extra + nonessential_power: none + non_essential_load1: sensor.nonessential1_power + non_essential_load2: sensor.nonessential2_power + grid_ct_power_172: sensor.sunsynk_grid_ct_power + grid_ct_power_L2: null + grid_ct_power_L3: null + grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status + inverter_status_59: sensor.sunsynk_overall_state + aux_power_166: sensor.sunsynk_aux_power + aux_connected_status: binary_sensor.sunsynk_aux_connected_status + remaining_solar: sensor.solcast_forecast_remaining_today + battery_temp_182: sensor.sunsynk_battery_temperature + radiator_temp_91: sensor.sunsynk_radiator_temperature + dc_transformer_temp_90: sensor.sunsynk_dc_transformer_temperature + environment_temp: sensor.home_realfeel_temperature + prog1_time: sensor.sunsynk_time_slot_1 + prog1_capacity: number.sunsynk_prog1_capacity + prog1_charge: switch.sunsynk_prog1_grid_charge + prog2_time: sensor.sunsynk_time_slot_2 + prog2_capacity: number.sunsynk_prog2_capacity + prog2_charge: switch.sunsynk_prog2_grid_charge + prog3_time: sensor.sunsynk_time_slot_3 + prog3_capacity: number.sunsynk_prog3_capacity + prog3_charge: switch.sunsynk_prog3_grid_charge + prog4_time: sensor.sunsynk_time_slot_4 + prog4_capacity: number.sunsynk_prog4_capacity + prog4_charge: switch.sunsynk_prog4_grid_charge + prog5_time: sensor.sunsynk_time_slot_5 + prog5_capacity: number.sunsynk_prog5_capacity + prog5_charge: switch.sunsynk_prog5_grid_charge + prog6_time: sensor.sunsynk_time_slot_6 + prog6_capacity: number.sunsynk_prog6_capacity + prog6_charge: switch.sunsynk_prog6_grid_charge + energy_cost_buy: sensor.tibber_energy_cost_buy + energy_cost_sell: sensor.tibber_energy_cost_sell + solar_sell_247: switch.sunsynk_toggle_solar_sell + aux_load1: sensor.gesyer + aux_load2: sensor.pool_pump + aux_load1_extra: sensor.daily_geyser_energy + aux_load2_extra: sensor.pool_temperature + load_power_L1: null + load_power_L2: null + load_power_L3: null + total_pv_generation: null + battery_status: null + + diff --git a/_sources/examples/victron.rst.txt b/_sources/examples/victron.rst.txt new file mode 100644 index 00000000..6e36a0fc --- /dev/null +++ b/_sources/examples/victron.rst.txt @@ -0,0 +1,169 @@ +################# +Victron Inverters +################# + +.. note:: + PAGE UNDER DEVELOPMENT + +****************************************************************************************** +Example 1 - Victron with Battery / Solar / No Grid +****************************************************************************************** + +Integration via https://github.com/nathanmarlor/foxess_modbus + +.. code-block:: yaml + :linenos: + +.. code-block:: yaml + :linenos: + + type: custom:sunsynk-power-flow-card + cardstyle: full + panel_mode: false + large_font: false + title: Victron - Power Monitor + title_colour: White + title_size: 18px + show_solar: true + show_grid: true + show_battery: true + decimal_places: 2 + dynamic_line_width: true + inverter: + modern: false + colour: grey + autarky: power + auto_scale: true + model: huawei + three_phase: false + battery: + energy: 14850 + shutdown_soc: sensor.battery_end_of_discharge_soc + invert_power: true + colour: '#fc8d83' + show_daily: true + animation_speed: 5 + max_power: 5000 + show_absolute: true + auto_scale: true + hide_soc: false + show_remaining_energy: true + dynamic_colour: true + linear_gradient: true + solar: + colour: '#F7BC00' + show_daily: true + mppts: 2 + animation_speed: 8 + max_power: 6600 + pv1_name: Inv1.S1 + pv2_name: Inv2.S1 + display_mode: 2 + auto_scale: true + load: + colour: magenta + show_daily: true + show_daily_aux: true + show_aux: true + invert_aux: false + show_absolute_aux: false + aux_name: Generator + aux_type: gen + aux_colour: '#5490c2' + aux_off_colour: brown + aux_loads: 2 + aux_load1_name: IT - Servers + aux_load2_name: IT - Network + aux_load1_icon: mdi:server-network + aux_load2_icon: mdi:network + animation_speed: 4 + essential_name: Essential + max_power: 4000 + additional_loads: 2 + load1_name: Lights + load2_name: All GPO + load3_name: Spare + load4_name: Spare + load1_icon: mdi:lightbulb + load2_icon: mdi:power-plug + load3_icon: mdi:water-boiler + load4_icon: mdi:kettle + auto_scale: true + dynamic_icon: true + dynamic_colour: true + grid: + grid_name: Your-Grid-Name + colour: '#FF2400' + export_colour: green + no_grid_colour: '#a40013' + grid_off_colour: '#e7d59f' + show_daily_buy: true + show_daily_sell: true + show_nonessential: true + invert_grid: true + nonessential_name: Non Essential + nonessential_icon: none + additional_loads: 2 + load1_name: HVAC + load2_name: EV + load1_icon: mdi:fan + load2_icon: mdi:car + animation_speed: 7 + max_power: 15000 + auto_scale: true + dynamic_icon: true + dynamic_colour: true + energy_cost_decimals: 3 + entities: + use_timer_248: null + priority_load_243: null + day_battery_charge_70: sensor.batteries_day_charge + day_battery_discharge_71: sensor.batteries_day_discharge + day_load_energy_84: sensor.house_consumption_energy_daily + day_grid_import_76: sensor.hs_grid_imported_daily + day_grid_export_77: sensor.hs_grid_exported_daily + day_pv_energy_108: sensor.inverters_daily_yield + day_aux_energy: sensor.sunsynk_card_aux_energy_daily + inverter_voltage_154: sensor.power_meter_voltage + load_frequency_192: sensor.power_meter_frequency + grid_power_169: sensor.house_consumption_power + inverter_current_164: sensor.inverter_phase_a_current + inverter_power_175: sensor.inverters_active_power + inverter_status_59: sensor.inverters_state + radiator_temp_91: null + dc_transformer_temp_90: sensor.inverters_internal_temperature + pv1_power_186: sensor.inverter_1_pv_1_power + pv2_power_187: sensor.inverter_1_pv_2_power + environment_temp: sensor._temp + remaining_solar: sensor.energy_production_today_remaining + pv1_voltage_109: sensor.inverter_pv_1_voltage + pv1_current_110: sensor.inverter_pv_1_current + pv2_voltage_111: sensor.inverter_pv_2_voltage + pv2_current_112: sensor.inverter_pv_2_current + battery_voltage_183: sensor.batteries_bus_voltage + battery_soc_184: sensor.batteries_state_of_capacity + battery_power_190: sensor.batteries_charge_discharge_power + battery_current_191: sensor.batteries_bus_current + battery_temp_182: sensor.batteries_temperature + battery_status: sensor.batteries_status + essential_power: sensor.house_consumption_power_less_aux_non_essential + essential_load1: sensor.lights_all_active_power + essential_load2: sensor.gpo_all_active_power_less_known + essential_load1_extra: null + essential_load2_extra: null + nonessential_power: sensor.sunsynk_card_non_essential_active_power + non_essential_load1: sensor.hvac_active_power + non_essential_load2: sensor.ev_charger_active_power + grid_ct_power_172: sensor.power_meter_active_power + grid_ct_power_total: sensor.power_meter_active_power + grid_connected_status_194: sensor.inverters_off_grid_status + aux_power_166: sensor.sunsynk_card_aux_active_power + aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status + energy_cost_buy: sensor.electricity_price + energy_cost_sell: sensor.electricity_fit + solar_sell_247: switch.null + aux_load1: sensor.it_hardware_network_active_power + aux_load2: sensor.it_hardware_servers_active_power + aux_load1_extra: sensor.env_network_rack_bme280_temperature + aux_load2_extra: sensor.garage_controller_bme280_temperature + grid_voltage: sensor.power_meter_voltage diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 00000000..7e549af1 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,9 @@ +.. include:: ../README.md + :parser: myst_parser.sphinx_ + +***************** +Table of Contents +***************** + +.. include:: toc.rst + diff --git a/_sources/toc.rst.txt b/_sources/toc.rst.txt new file mode 100644 index 00000000..9fcf1a25 --- /dev/null +++ b/_sources/toc.rst.txt @@ -0,0 +1,27 @@ +.. toctree:: + :caption: Configuration + :titlesonly: + + configuration + +.. toctree:: + :caption: Examples + :titlesonly: + + examples/sunsynk + examples/lux + examples/solis + examples/goodwe + examples/foxess + examples/solax + examples/huawei + examples/victron + +.. toctree:: + :caption: Contribute + :titlesonly: + + contribute/bugs + contribute/devcontainer + contribute/devcycle + contribute/docs diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..81415803 --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 00000000..30fee9d0 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 00000000..d06a71d7 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 00000000..7e4c114f --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/html5shiv.min.js b/_static/js/html5shiv.min.js new file mode 100644 index 00000000..cd1c674f --- /dev/null +++ b/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/theme.js b/_static/js/theme.js new file mode 100644 index 00000000..1fddb6ee --- /dev/null +++ b/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 00000000..84ab3030 --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 00000000..7918c3fa --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 00000000..8a96c69a --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/configuration.html b/configuration.html new file mode 100644 index 00000000..3d6e3748 --- /dev/null +++ b/configuration.html @@ -0,0 +1,1301 @@ + + + + + + + Configuration — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Configuration

+

The card can be configured through the following attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute

Requirement

Default

Description

type:

Required

custom:sunsynk-power-flow-card

The custom card

cardstyle:

Required

lite

Selects the card layout that is used compact, lite or full

panel_mode:

Optional

false

Toggles panel mode setting card height to 100%. For use with Panel(1 card) view types or grid layouts

large_font:

Optional

false

Increases font size of sensor data

title:

Optional

Set the card title i.e. Inverter One

title_colour:

Optional

Sets the colour of the card title. (red, green, blue etc)

title_size:

Optional

32px

Set the font size for the card title i.e. 16px, 24px

show_solar:

Optional

true

Toggle display of solar information

show_battery:

Optional

true

Toggle display of battery information

show_grid:

Optional

true

Toggle display of grid information

card_height:

Optional

396px

Only used when panel_mode: false. Sets the card height in pixels. Specify the value i.e. 400px or provide a sensor i.e. input.numer_height

card_width:

Optional

100%

Only used when panel_mode: true. Sets the card width in pixels or percentage 400px or 80%. For adjustments when using the Panel(1 card) view types or grid layouts

decimal_places:

Optional

2

Sets the number of decimal places to display when using the auto_scale option.

dynamic_line_width:

Optional

false

Adjusts the width of the lines and animated dot based on the ratio of current power to max_power (defined in each section below). Requires max_power to be explicitly defined

max_line_width:

Optional

4

Sets the maximum line width when dynamic_line_width: true. If you prefer thick lines set a larger value. Reduce this value for a more subtle scaling affect. Values greater the 8 are ignored

min_line_width:

Optional

1

Sets the minimum or default line width on the card. Values greater the 8 are ignored

inverter:

Optional

See optional Inverter attributes below

List of inverter attributes.

battery:

Optional

See required Battery attributes below

List of battery attributes. Required if show_battery: true

solar:

Optional

See optional Solar attributes below

List of solar attributes.

load:

Optional

See optional Load attributes below

List of load attributes.

grid:

Optional

See optional Grid attributes below

List of grid attributes.

entities:

Required

See required Entities attributes below

List of sensor entities.

+
+

Inverter

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute

Requirement

Default

Description

modern:

Optional

true

Display the inverter using the modern image. Set to false to display an image of the inverter based on the model attribute below.

colour:

Optional

grey

Sets the colour of the inverter and data. Hex codes ('#66ff00' etc) or names (red, green, blue etc)

autarky:

Optional

power

Display autarky and ratio as a percentage using either realtime power or daily energy values. Set to no to hide (energy/power/no).
Autarky is the percentage of self sufficiency through Home Production. Ratio is the percentage of produced electricity used by the home.
It is calculated based on the formula below and borrowed from the Power Distribution Card

  • Autarky in Percent = Home Production / Home Consumption
  • Ratio in Percent = Home Consumption / Home Production

model:

Optional

sunsynk

Selects which inverter image and status codes to use. Options are lux, solis, goodwe, goodwe_gridmode, foxess, solax, sunsynk, victron, fronius, solaredge, growatt, sofar, ces-battery-box, deye, azzurro, powmr and huawei.

auto_scale:

Optional

true

If set to true the card will use the entities unit_of_measurement attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the decimal_places card attribute apart from the daily energy values which are rounded to 1 decimal place

three_phase:

Optional

false

If set to true additional 3 phase sensors will be displayed. Requires entity attributes to be defined i.e. inverter_current_L2, inverter_current_L3, inverter_voltage_L2, inverter_voltage_L3 , grid_ct_power_L2, grid_ct_power_L3, load_power_L1, load_power_L2, load_power_L3

+
+
+

Battery

+

To display battery power and current as absolute values set show_absolute: true. This is set to false by default and +will return your sensor value. The animated dot will change direction depending on the charging or discharging state. +The invert_power attribute can be used to reverse direction if needed by your sensor.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute

Requirement

Default

Description

energy:

Required

0

Total battery energy in Wh (e.g. 3 x 5.32kWh = 15960). If set to 0 the remaining battery runtime will be hidden. Numeric value or sensor i.e. sensor.sunsynk_battery_energy

shutdown_soc:

Required

20

The battery shutdown percentage used to calculate remaining runtime. Numeric value or sensor i.e. sensor.sunsynk_battery_capacity_shutdown

shutdown_soc_offgrid:

Optional

Only applies for Goodwe and Huawei inverters. The offgrid battery shutdown percentage used to calculate remaining runtime. Numeric value or sensor i.e. sensor.offgrid_battery_capacity_shutdown

invert_power:

Optional

false

Set to true if your sensor provides a positive number for battery charge and negative number for battery discharge

colour:

Optional

pink

Sets the colour of all the battery card objects. Hex codes ('#66ff00' etc) or names (red, green, blue etc)

charge_colour:

Optional

Sets the colour of all the battery card objects when charging. Hex codes ('#66ff00' etc) or names (red, green, blue etc)

dynamic_colour:

Optional

true

The battery icon colour will change based on the % contribution of the power source (grid, solar) supplying the battery. Set to false to disable. If priority_load_243: on solar will prioritise the essential load. If false or ommited solar will prioritise the battery.

linear_gradient:

Optional

true

The blocks inside the battery icon that represent SOC will be coloured using a linear gradient that ranges from red to green

show_daily:

Optional

false

Toggles the daily total

animation_speed:

Optional

6

Set slowest animation speed in seconds, depending on power draw

max_power:

Optional

4500

Maximum power draw to calculate animation speed. Numeric value or sensor i.e. number.battery_maximum_discharging_power

show_absolute:

Optional

false

set to true to display power and current as absolute values

auto_scale:

Optional

true

If set to true the card will use the entities unit_of_measurement attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the decimal_places card attribute apart from the daily energy values which are rounded to 1 decimal place

hide_soc:

Optional

false

If set to true the current program capacity (soc), or for Goodwe inverters the shutdown soc and offgrid shutdown soc that is shown to the left of the current battery SOC will be hidden.

show_remaining_energy:

Optional

true

Set to true to display the remaining battery energy in kWh based on the current SOC. Only visable on the lite and full cards

+
+
+

Solar

+

These attributes are only needed if show_solar is set to true

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute

Requirement

Default

Description

colour:

Optional

orange

Sets the colour of all the solar card objects. Hex codes ('#66ff00' etc) or names (red, green, blue etc)

show_daily:

Optional

false

Toggles the daily total

display_mode:

Optional

1

1 - Only display the daily total, 2 - Display the daily total and remaining daily forecast, 3 - Display the daily total and total solar generation

dynamic_colour:

Optional

true

The solar elements on the card will be greyed out if total solar power < 10W.

mppts:

Required

2

Specify the number of MPPT’s in use 1, 2, 3 or 4

animation_speed:

Optional

9

Set slowest animation speed in seconds, depending on Power produced

max_power:

Optional

8000

Maximum power draw to calculate animation speed

pv1_name:

Optional

PV1

Set the disaply name for MPPT1

pv2_name:

Optional

PV2

Set the disaply name for MPPT2

pv3_name:

Optional

PV3

Set the disaply name for MPPT3

pv4_name:

Optional

PV4

Set the disaply name for MPPT4

auto_scale:

Optional

true

If set to true the card will use the entities unit_of_measurement attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the decimal_places card attribute apart from the daily energy values which are rounded to 1 decimal place

+
+
+

Load

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute

Requirement

Default

Description

colour:

Optional

'#5fb6ad'

Setss the colour of all the load card objects. Hex codes ('#66ff00' etc) or names (red, green, blue etc)

dynamic_colour:

Optional

true

The essential icon colour will change based on the % contribution of the power source (battery, grid, solar) supplying the load. Set to false to disable

dynamic_icon:

Optional

true

The essential icon will change when there is 100% contribution from a single power source (battery, grid, solar). Set to false to disable

invert_load:

Optional

false

Set to true if your sensor provides a negative number when the load is drawing power

show_daily:

Optional

false

Toggles the daily total.

show_daily_aux:

Optional

false

Toggles the daily AUX total. Only displayed if show_aux is set to true

show_aux:

Optional

false

Toggles the display of AUX

invert_aux:

Optional

false

Set to true if your sensor provides a positive number for AUX input and negative number for AUX output

show_absolute_aux:

Optional

false

set to true to display power as an absolute value

animation_speed:

Optional

8

Set slowest animation speed in seconds, depending on Power draw

max_power:

Optional

8000

Maximum power draw to calculate animation speed

aux_name:

Optional

Auxilary

Set the display name for the AUX Load

aux_type:

Optional

default

Sets the AUX image using preset or any mdi icon e.g. mdi:ev-station. Presets are: gen, inverter default, oven, pump, aircon and boiler.

aux_colour:

Optional

the load colour

Sets the colour of all the AUX card objects. Hex codes ('#66ff00' etc) or names (red, green, blue etc)

aux_dynamic_colour:

Optional

true

The respective aux elements on the card will be greyed out if aux power = 0W.

aux_off_colour:

Optional

the load colour

Sets the colour of the AUX icon and label when disconnected. Hex codes ('#66ff00' etc) or names (red, green, blue etc)

aux_loads:

Optional

0

Display additional loads on the AUX side (0/1/2)

aux_load1_name:

Optional

Set the display name for the AUX load 1

aux_load2_name:

Optional

Set the display name for the AUX load 2

aux_load1_icon:

Optional

Set the AUX load 1 image using any mdi icon e.g. mdi:ev-station

aux_load2_icon:

Optional

Set the AUX load 2 image using any mdi icon e.g. mdi:ev-station

essential_name:

Optional

Essential

Set the display name for the essential load

additional_loads:

Optional

0

Display additional loads on the essential side (0/1/2/3/4). Three and four additional loads will only be visable when using the lite/compact card

load1_name:

Optional

Set the display name for the essential load 1

load2_name:

Optional

Set the display name for the essential load 2

load3_name:

Optional

Set the display name for the essential load 3 (Lite card only)

load4_name:

Optional

Set the display name for the essential load 4 (Lite card only)

load1_icon:

Optional

none

Set the essential load 1 image using preset or any mdi icon e.g. mdi:ev-station Presets are: boiler, pump, aircon, oven

load2_icon:

Optional

none

Set the essential load 2 image using preset or any mdi icon e.g. mdi:ev-station Presets are: boiler, pump, aircon, oven

load3_icon:

Optional

none

Set the essential load 3 image using any mdi icon e.g. mdi:ev-station Presets are not available when showing 4 essential loads

load4_icon:

Optional

none

Set the essential load 4 image using any mdi icon e.g. mdi:ev-station Presets are not available when showing 4 essential loads

auto_scale:

Optional

true

If set to true the card will use the entities unit_of_measurement attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the decimal_places card attribute apart from the daily energy values which are rounded to 1 decimal place

+
+
+

Grid

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute

Requirement

Default

Description

colour:

Optional

'#5490c2'

Sets the colour of all the grid card objects. Hex codes ('#66ff00' etc) or names (red, green, blue etc).

grid_name:

Optional

Set the display name for the grid

export_colour:

Optional

Sets the colour of all the grid card objects when exporting (selling) energy. Hex codes ('#66ff00' etc) or names (red, green, blue etc). If not set will use the colour: value defined above.

no_grid_colour:

Optional

Sets the colour of all the grid card objects when there is no grid power. Hex codes ('#66ff00' etc) or names (red, green, blue etc). If not set will use the colour: value defined above total

grid_off_colour:

Optional

Sets the colour of the grid icon when the grid is disconnected.

show_daily_buy:

Optional

false

Toggles the daily buy total

show_daily_sell:

Optional

false

Toggles the daily sell total

show_nonessential:

Optional

true

Toggles the display of non-essential

nonessential_icon:

Optional

default

Change the non-essential image using presets or any mdi icon e.g. mdi:ev-station. Presets are:
default oven, boiler

pump, aircon

nonessential_name:

Optional

Non Essential

Set the display name for the non-essential load

additional_loads:

Optional

0

Toggle the display of additional loads on the non-essential side (0/1/2/3) The third load will only be displayed if the inverter timer schedules are not used due to limited space. Set the battery attribute hide_soc: true to display

load1_name:

Optional

Set the display name for the non-essential load 1

load2_name:

Optional

Set the display name for the non-essential load 2

load3_name:

Optional

Set the display name for the non-essential load 3

load1_icon:

Optional

default

Change the non-essential load 1 image using presets or any mdi icon e.g. mdi:ev-station. Presets are: default, oven, boiler, pump, aircon

load2_icon:

Optional

default

Change the non-essential load 2 image using presets or any mdi icon e.g. mdi:ev-station. Presets are: default, oven, boiler, pump, aircon

load3_icon:

Optional

none

Change the non-essential load 3 image using any mdi icon e.g. mdi:ev-station.

invert_grid:

Optional

false

Set to true if your sensor provides a negative number for grid import and positive number for grid export

show_absolute:

Optional

false

set to true to display power as absolute

animation_speed:

Optional

8

Set slowest animation speed in seconds, depending on power draw

max_power:

Optional

8000

Maximum power draw to calculate animation speed

auto_scale:

Optional

true

If set to true the card will use the entities unit_of_measurement attribute to perform the correct scaling (i,e, power values greater than 999W will be displayed as kW e.g. 1.23kW) and display the correct unit. The number of decimal places can be changed using the decimal_places card attribute apart from the daily energy values which are rounded to 1 decimal place

energy_cost_decimals:

Optional

2

Sets the number of decimal places to display the buy and sell energy costs

+
+
+

Entities

+

Entity attributes below have been appended with the modbus register # e.g. pv2_power_187 to indicate which Sunsynk +register should be read when configuring your sensors. Replace the default sensors with your own specific sensor names. +It is important that your sensors read the expected modbus register value. If you have missing sensors for any attribute +set it to none i.e. day_pv_energy_108: none. This will hide the sensor data from the card. To display a placeholder +with a default value of 0 set it to zero or any other value i.e. solarday_108: zero.

+

See the WIKI for more information on sensor +mappings if using other integration methods.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute

Requirement

Default

Description

use_timer_248:

Optional

switch.sunsynk_toggle_system_timer

Displays “Use timer” status as an icon next to the inverter. Set to no to hide

priority_load_243:

Optional

switch.sunsynk_toggle_priority_load

Shows if energy pattern is set to priority load or priority battery as an icon next to the inverter. Set to no to hide

day_battery_discharge_71:

Optional

sensor.sunsynk_day_battery_discharge

Daily battery usage (kWh)

day_battery_charge_70:

Optional

sensor.sunsynk_day_battery_charge

Daily battery charge (kWh)

day_load_energy_84:

Optional

sensor.sunsynk_day_load_energy

Daily load (kWh)

day_grid_import_76:

Optional

sensor.sunsynk_day_grid_import

Daily grid import (kWh)

day_grid_export_77:

Optional

sensor.sunsynk_day_grid_export

Daily grid export (kWh)

day_pv_energy_108:

Optional

sensor.sunsynk_day_pv_energy

Daily solar usage (kWh)

day_aux_energy:

Optional

Sensor that provides the daily AUX energy (kWh)

inverter_voltage_154:

Optional

sensor.sunsynk_inverter_voltage

Inverter L1 voltage (V)

inverter_voltage_L2:

Optional

Inverter L2 voltage (V)

inverter_voltage_L3:

Optional

Inverter L3 voltage (V)

load_frequency_192:

Optional

sensor.sunsynk_load_frequency

Load frequency (Hz)

inverter_current_164:

Optional

sensor.sunsynk_inverter_current

Inverter L1 current (A)

inverter_current_L2:

Optional

Inverter L2 current (A)

inverter_current_L3:

Optional

Inverter L3 current (A)

inverter_power_175:

Optional

sensor.sunsynk_inverter_power

Inverter power (W). Required if the essential_power attribute is set to none

grid_power_169:

Optional

sensor.sunsynk_grid_power

Grid power (W) See NOTE below. Use 167 (Grid LD Power) if non-essential and essential readings are wrong. Required if the nonessential_power attribute is set to none

pv1_power_186:

Optional

sensor.sunsynk_pv1_power

PV string 1 power (W)

pv2_power_187:

Optional

sensor.sunsynk_pv2_power

PV string 2 power (W)

pv3_power_188:

Optional

sensor.sunsynk_pv3_power

PV string 3 power (W)

pv4_power_189:

Optional

sensor.sunsynk_pv4_power

PV string 4 power (W)

pv_total:

Optional

none

Provide a sensor for total pv power. If omitted the card uses internal logic to calculate this based on the pv1-4 power (W)

battery_voltage_183:

Optional

sensor.sunsynk_battery_voltage

Battery voltage (V)

battery_soc_184:

Required

sensor.sunsynk_battery_soc

Battery state of charge (%)

battery_power_190:

Required

sensor.sunsynk_battery_power

Battery power (W). Requires a negative number for battery charging and a positive number for battery discharging. Set the invert_power: battery attribute to yes if your sensor reports this the other way around

battery_current_191:

Required

sensor.sunsynk_battery_current

Battery current (A)

battery_temp_182:

Optional

sensor.sunsynk_battery_temperature

Battery temperature (℃)

battery_rated_capacity

Optional

Battery rated capacity (Ah). If provided this sensor will be used to calculate battery energy. Theenergy attribute under the battery card configuration will be ignored.

essential_power:

Optional

none

The card will automatically calculate this sensor based on the formula below if the attribute is set to none or the sensor is not defined. You can overide this by supplying a sensor that measures essential power e.g. Load power Essential in the case of Solar Assistant (W)

essential_load1:

Optional

Sensor that contains the power of your essential load 1 (W). Can also be used to display any sensor data i.e. temp, energy etc if auto_scale: false

essential_load2:

Optional

Sensor that contains the power of your essential load 2 (W). Can also be used to display any sensor data i.e. temp, energy etc if auto_scale: false

essential_load3:

Optional

Sensor that contains the power of your essential load 3 (W). Can also be used to display any sensor data i.e. temp, energy etc if auto_scale: false For Lite view only

essential_load4:

Optional

Sensor that contains the power of your essential load 4 (W). Can also be used to display any sensor data i.e. temp, energy etc if auto_scale: false For Lite view only

essential_load1_extra:

Optional

Sensor that contains additional information you want displayed for your essential load 1 e.g. Daily kWh, Temperature etc

essential_load2_extra:

Optional

Sensor that contains additional information you want displayed for your essential load 2 e.g. Daily kWh, Temperature etc

load_power_L1:

Optional

Load L1 Power (W)

load_power_L2:

Optional

Load L2 Power (W)

load_power_L3:

Optional

Load L3 Power (W)

nonessential_power

Optional

none

The card will automatically calculate this sensor based on the formula below if the attribute is set to none or the sensor is not defined. You can overide this by supplying a sensor that measures non-essential power e.g. Load power Non-Essential in the case of Solar Assistant. (W)

non_essential_load1:

Optional

Sensor that contains the power of your non-essential load 1 (W)

non_essential_load2:

Optional

Sensor that contains the power of your non-essential load 2 (W)

non_essential_load3:

Optional

Sensor that contains the power of your non-essential load 3 (W)

non_essential_load1_extra:

Optional

Sensor that contains additional information you want displayed for your nonessential load 1 e.g. Daily kWh, Temperature etc

non_essential_load2_extra:

Optional

Sensor that contains additional information you want displayed for your nonessential load 2 e.g. Daily kWh, Temperature etc

grid_ct_power_total:

Optional

For three phase systems. The card will automatically calculate this based on (Grid CT L1 power + Grid CT L2 power + Grid CT L3 power) You can optionally provide your own sensor for total grid power. (W)

grid_ct_power_172:

Required

sensor.sunsynk_grid_ct_power

Grid CT L1 power (W)

grid_ct_power_L2:

Optional

none

Grid CT L2 power (W)

grid_ct_power_L3:

Optional

none

Grid CT L3 power (W)

pv1_voltage_109:

Optional

sensor.sunsynk_pv1_voltage

PV string 1 voltage (V)

pv1_current_110:

Optional

sensor.sunsynk_pv1_current

PV string 1 current (A)

pv2_voltage_111:

Optional

sensor.sunsynk_pv2_voltage

PV string 2 voltage (V)

pv2_current_112:

Optional

sensor.sunsynk_pv2_current

PV string 2 current (A)

pv3_voltage_113:

Optional

sensor.sunsynk_pv3_voltage

PV string 3 voltage (V)

pv3_current_114:

Optional

sensor.sunsynk_pv3_current

PV string 3 current (A)

pv4_voltage_115:

Optional

sensor.sunsynk_pv4_voltage

PV string 4 voltage (V)

pv4_current_116:

Optional

sensor.sunsynk_pv4_current

PV string 4 current (A)

grid_connected_status_194:

Optional

binary_sensor.sunsynk_grid_connected_status

Grid connected status (case insensitive) on/off,1/0, On-Grid/Off-Grid, or On Grid/Off Grid

inverter_status_59:

Optional

sensor.sunsynk_overall_state

Expects a sensor that contains inverter status represented as a string or number. For Sunsynk 0, 1, 2, 3, 4 or standby, selftest, normal, alarm, fault. For Lux 0,1,2,4,5,7,8,9,10,11,12,16,17,20,32,40,64,136,192. For Solis expects a numeric value 0-57. For Goodwe 0,1,2,3,4,5 or Wait mode, Normal (On-Grid), Normal (Off-Grid), Fault Mode, Flash Mode, Check Mode. For Goodwe_gridmode 0,1,2 or Idle, Exporting, Importing

battery_status:

Optional

sensor.battery_mode_code

Used only when inverter model is set to goodwe, goodwe_gridmode or huawei. Battery status 0, 1, 2, 3, 4

aux_power_166:

Optional

sensor.sunsynk_aux_power

Auxilary power (W)

aux_load1:

Optional

Sensor that contains the power of your AUX load 1 (W)

aux_load2:

Optional

Sensor that contains the power of your AUX load 2 (W)

aux_load1_extra:

Optional

Sensor that contains additional information you want displayed for your aux load 1 e.g. Daily kWh, Temperature etc

aux_load2_extra:

Optional

SSensor that contains additional information you want displayed for your aux load 2 e.g. Daily kWh, Temperature etc

aux_connected_status:

Optional

AUX Connected Status on/off or 1/0

remaining_solar:

Optional

sensor.solcast_forecast_remaining_today

The remaining solar forecast for the day (kWh). Use with solar display_mode:2

total_pv_generation:

Optional

Total Solar generation (Lifetime or forecast for the day) (kWh). Use with solar display_mode:3

radiator_temp_91:

Optional

sensor.sunsynk_radiator_temperature

Inverter AC temperature (℃)

environment_temp:

Optional

Display outside temperature or other environment temperature below the sun icon

dc_transformer_temp_90:

Optional

sensor.sunsynk_dc_transformer_temperature

Inverter DC temperature (℃)

prog1_time:

Optional

sensor.sunsynk_time_slot_1

Program 1 start time (HH:MM)

prog1_capacity:

Optional

number.sunsynk_system_mode_soc_time1

Program 1 capacity (SOC) setting

prog1_charge:

Optional

switch.sunsynk_system_mode_grid_charge_time1

Program 1 charge options (on/off, 1/0, No Grid or Gen)

prog2_time:

Optional

sensor.sunsynk_time_slot_2

Program 2 start time (HH:MM)

prog2_capacity:

Optional

number.sunsynk_system_mode_soc_time2

Program 2 capacity (SOC) setting

prog2_charge:

Optional

switch.sunsynk_system_mode_grid_charge_time2

Program 2 charge options (on/off, 1/0, No Grid or Gen)

prog3_time:

Optional

sensor.sunsynk_time_slot_3

Program 3 start time (HH:MM)

prog3_capacity:

Optional

number.sunsynk_system_mode_soc_time3

Program 3 capacity (SOC) setting

prog3_charge:

Optional

switch.sunsynk_system_mode_grid_charge_time3

Program 3 charge options (on/off, 1/0, No Grid or Gen)

prog4_time:

Optional

sensor.sunsynk_time_slot_4

Program 4 start time (HH:MM)

prog4_capacity:

Optional

number.sunsynk_system_mode_soc_time4

Program 4 capacity (SOC) setting

prog4_charge:

Optional

switch.sunsynk_system_mode_grid_charge_time4

Program 4 charge options (on/off, 1/0, No Grid or Gen)

prog5_time:

Optional

sensor.sunsynk_time_slot_5

Program 5 start time (HH:MM)

prog5_capacity:

Optional

number.sunsynk_system_mode_soc_time5

Program 5 capacity (SOC) setting

prog5_charge:

Optional

switch.sunsynk_system_mode_grid_charge_time5

Program 5 charge options (on/off, 1/0, No Grid or Gen)

prog6_time:

Optional

sensor.sunsynk_time_slot_6

Program 6 start time (HH:MM)

prog6_capacity:

Optional

number.sunsynk_system_mode_soc_time6

Program 6 capacity (SOC) setting

prog6_charge:

Optional

switch.sunsynk_system_mode_grid_charge_time6

Program 6 charge options (on/off, 1/0, No Grid or Gen)

energy_cost_buy:

Optional

Sensor that provides current buy energy cost per kWh

energy_cost_sell:

Optional

Sensor that provides current sell energy cost per kWh

solar_sell_247:

Optional

switch.sunsynk_toggle_solar_sell

Displays icons to indicate if sell solar is active or not. The switch can be toggled by clicking on the icon (on/off, 1/0)

grid_voltage:

Optional

sensor.solis_grid_voltage

Sensor providing grid voltage (v). Used only when inverter model is set to solis

battery_current_direction:

Optional

sensor.solis_battery_current_direction

Used only when inverter model is set to solis (0, 1)

prepaid_units:

Optional

Account balance of prepaid electricity units

+

The card calculates the sensors below based on supplied attributes in the config so you dont need to define them in Home +Assistant. NOTE if your essential and non-essential readings are innacurate replace sensor 169 with 167. Alternatively +provide the card with sensors that calculate this data i.e essential_power: and nonessential_power:

+

If three_phase:false

+
totalsolar = pv1_power_186 + pv2_power_187 + pv3_power_188 + pv4_power_189
+nonessential = grid_ct_power_172 - grid_power_169
+essential = inverter_power_175 + grid_power_169 - aux_power_166
+
+
+

If three_phase:true

+
 totalsolar = pv1_power_186 + pv2_power_187 + pv3_power_188 + pv4_power_189
+ nonessential = grid_ct_power_172 + grid_ct_power_L2 + grid_ct_power_L3 - grid_power_169
+ essential =  load_power_L1 +  load_power_L2 +  load_power_L3
+
+
+

The modbus registers can be visualised on the full card below:

+

image

+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/contribute/bugs.html b/contribute/bugs.html new file mode 100644 index 00000000..cce5e675 --- /dev/null +++ b/contribute/bugs.html @@ -0,0 +1,196 @@ + + + + + + + Reporting Bugs — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Reporting Bugs

+

This section guides you through submitting a bug report for the Sunsynk Power Flow Card. +Following these guidelines helps maintainers and the community understand your report, +reproduce the behaviour, and find related reports.

+

Before creating bug reports, please check the below information as you might find out +that you don’t need to create one. When you are creating a bug report, +please include as many details as possible, the information it asks for helps +us resolve issues faster.

+
+

Note

+

If you find a Closed issue that seems like it is the same thing that you’re +experiencing, open a new issue and include a link to the original issue in the +body of your new one.

+
+
+

Before Submitting A Bug Report

+
    +

  • Perform a cursory search +to see if the problem has already been reported. If it has and the issue is still open, add a comment to +the existing issue instead of opening a new one.

    • +
+
+
+

How do i submit a bug report?

+

Bugs are tracked as GitHub issues. +After you’ve determined this is not a configuration issue, create an issue on github +and provide the following information by filling in the template.

+

Explain the problem and include additional details to help maintainers reproduce the problem:

+
    +

  • Use a clear and descriptive title for the issue to identify the problem.

    • +

  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you installed the plugin. When listing steps, don’t just say what you did, but explain how you did it. For example, did you use the Lovelace Editor or do the change in YAML directly.

    • +

  • Provide specific examples to demonstrate the steps. Include screenshots, or copy/pasteable configuration snippets, which you use in those examples. If you’re providing snippets in the issue, use Markdown code blocks.

    • +

  • Describe the behaviour you observed after following the steps and point out what exactly is the problem with that behaviour.

    • +

  • Explain which behaviour you expected to see instead and why.

    • +

  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

    • +

  • If Chrome’s developer tools pane is showing errors, include these in your report

    • +

  • If the problem wasn’t triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

    • +
+

Provide more context by answering these questions:

+
    +

  • Did the problem start happening recently (e.g. after updating to a new version of HA / Sunsynk Power Flow Card) or was this always a problem?

    • +

  • If the problem started happening recently, can you reproduce the problem in an older version of the card? What’s the most recent version in which the problem doesn’t happen? You can install older versions of Atomic Calendar Revive via HACS or from the releases page on github

    • +

  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/contribute/devcontainer.html b/contribute/devcontainer.html new file mode 100644 index 00000000..9ac1d812 --- /dev/null +++ b/contribute/devcontainer.html @@ -0,0 +1,185 @@ + + + + + + + VS Code - DevContainer — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

VS Code - DevContainer

+

The easiest way to get your development environment setup is by using VS Code +with Dev Containers, this utilises Docker containers to setup a development +environment that guarantees a match with all other developers, removing any +potential headaches from incompatibilities.

+
+

Requirements

+
    +

  • VS Code

    • +

  • Docker

    • +

  • Remote - Containers (VS Code extension)

    • +
+
+
+

Configuration

+
    +

  1. Copy the recommended files inside .devcontainer

    2. +

  2. Paste them in the same folder, remove the recommended- from the filename

    3. +

  3. In most cases no other changes will be required with these files

    4. +
+
+

Note

+

Please ensure that the recommended-xxx files are not removed as this would remove +them from the repository when committed.

+
+

When you open the repository with VS Code, a prompt to “Reopen in container” should +now appear. This will start the build of the development container with all components +and extensions pre-installed.

+
+

Note

+

If you don’t see the notification, open the command pallet and select +Dev Containers: Open Folder in Container

+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/contribute/devcycle.html b/contribute/devcycle.html new file mode 100644 index 00000000..a2450d4d --- /dev/null +++ b/contribute/devcycle.html @@ -0,0 +1,246 @@ + + + + + + + Development Cycle — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Development Cycle

+

The below will provide a guide on how you should develop for this plugin to have your +code reviewed and accepted.

+
+

Setup Repository

+
    +

  • Fork the repo in github

    • +

  • Clone the project to your development machine

    • +
+
git clone https://github.com/your-username/sunsynk-power-flow-card.git
+
+
+
+
+

Create Topic Branch

+

You should always work on a new topic branch for each feature / bug you are working on. +Also you must ensure that you have pulled the latest version from upstream see below.

+

Start by setting up an upstream remote, this will be used to pull the latest version +from the main repository:

+
git remote add upstream https://github.com/slipx06/sunsynk-power-flow-card
+
+
+

Checkout the master branch and pull the latest upstream version:

+
git checkout master
+git fetch upstream
+git merge upstream/master
+git push
+
+
+

Your fork should now be in sync with the main repository, now a new branch +is required for development.

+
git checkout -b <issue-number>_<feature/bug-name>
+git checkout -b 100_Fix-the-bug
+
+
+
+

Note

+

The branch should have a relevant short name starting with the issue number +and then having a name for the fix / feature as shown in the example above.

+
+
+
+

Install Dependencies

+

From the cloned repository, run the command to install the requirements:

+
yarn install
+
+
+
+
+

Make changes & Build

+
    +

  1. Any changes to the card should be made in the folder src

    2. +

  2. Update the version number in package.json

    3. +

  3. Run the command yarn run build to create the latest distribution file

    4. +
+
+
+

Testing

+

There are no automated tests for this project, however it is expected that any +development work is tested against a HA Server with working inverter integration, +this ensures no adverse impact is added with the feature or bugfix.

+
+
+

Versioning

+

This project follows Semantic Versioning

+

MAJOR.MINOR.PATCH

+

In the context of semantic versioning, the following should apply:

+
    +

  • Major - A breaking change that requires user invervention, or a change to a +default value.

    • +

  • Minor - A change that does not require intervention, or adds additional +functionality in a backwards compatible manner.

    • +

  • Patch - A change that resolves a specific bug.

    • +
+

All changes are tracked in the release notes

+
+
+

Commit Changes

+

Once you are happy with the changes, these can be committed:

+
git add .
+git commit -v -m "feat: 100 Added new feature"
+
+
+
+

Note

+

Commit messages should follow conventional commits +this ensures clear commit messages within the repository.

+
+
+
+

Submit Pull Request

+

Once development & testing are completed a pull request can be submitted for +the change that is required, ensure that all tests are passing and once they +are a member of the team will review the request, test and merge if appropriate

+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/contribute/docs.html b/contribute/docs.html new file mode 100644 index 00000000..48b7f9b4 --- /dev/null +++ b/contribute/docs.html @@ -0,0 +1,167 @@ + + + + + + + Documentation — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Documentation

+

The documentation for this repo is built using Sphinx, the site is re-built +on each release of the card and pushed to github pages.

+
+

How to Contribute

+

There are two ways of contributing to the documentation:

+
    +

  1. Editing the files within the docs folder.

    2. +

  2. Raising an issue for something to be fixed on the next release.

    3. +
+

The documentation utilises Sphinx RestructuredText

+
+
+

Adding pages

+

To add new pages, add a new file in the appropriate directory, and then add a reference +to the toc.rst file under the correct heading.

+

You can test the pages added by running the command yarn run docs-build

+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/examples/foxess.html b/examples/foxess.html new file mode 100644 index 00000000..0f814f03 --- /dev/null +++ b/examples/foxess.html @@ -0,0 +1,248 @@ + + + + + + + FoxESS Inverter — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

FoxESS Inverter

+
+

Example 1 - Integration via https://github.com/nathanmarlor/foxess_modbus

+
 1  type: custom:sunsynk-power-flow-card
+ 2  cardstyle: full
+ 3  panel_mode: true
+ 4  card_width: 80%
+ 5  show_solar: true
+ 6  inverter:
+ 7    auto_scale: true
+ 8    colour: '#b6baa9'
+ 9    modern: true
+10    model: foxess
+11    autarky: power
+12  battery:
+13    energy: 33000
+14    shutdown_soc: 35
+15    colour: pink
+16    max_power: 9000
+17    show_daily: true
+18    auto_scale: true
+19  solar:
+20    show_daily: true
+21    mppts: 3
+22    auto_scale: true
+23    max_power: 5000
+24    pv1_name: 1 South F
+25    pv2_name: 2 South R
+26    pv3_name: 3 North
+27  load:
+28    show_daily: false
+29    auto_scale: true
+30    additional_loads: 2
+31    load1_name: HW
+32    load1_icon: mdi:water-boiler
+33    load2_name: Kitchen
+34    load2_icon: mdi:stove
+35    show_aux: true
+36    aux_name: Climate
+37    aux_loads: 2
+38    aux_load1_name: Mitsu AC/Heat
+39    aux_load1_icon: mdi:heat-pump-outline
+40    aux_load2_name: Mirror Heater
+41    aux_load2_icon: mdi:mirror-rectangle
+42    essential_name: Main
+43  grid:
+44    show_daily_buy: true
+45    show_daily_sell: true
+46    max_power: 12000
+47    auto_scale: true
+48    show_nonessential: true
+49    nonessential_name: EV
+50    nonessential_icon: mdi:ev-station
+51    invert_grid: true
+52  entities:
+53    use_timer_248: 'no'
+54    priority_load_243: 'no'
+55    inverter_voltage_154: sensor.emontx4_vrms
+56    inverter_current_164: sensor.foxess_rcurrent
+57    inverter_power_175: sensor.foxess_rpower
+58    grid_connected_status_194: sensor.foxess_inverter_state
+59    inverter_status_59: sensor.foxess_inverter_state
+60    day_battery_charge_70: sensor.foxess_battery_charge_today
+61    day_battery_discharge_71: sensor.foxess_battery_discharge_today
+62    battery_voltage_183: sensor.foxess_batvolt
+63    battery_soc_184: sensor.foxess_battery_soc
+64    battery_power_190: sensor.foxess_invbatpower
+65    battery_current_191: sensor.foxess_invbatcurrent
+66    day_grid_import_76: sensor.foxess_grid_consumption_energy_today
+67    day_grid_export_77: sensor.foxess_feed_in_energy_today
+68    grid_power_169: sensor.foxess_load_power
+69    grid_ct_power_172: sensor.foxess_grid_ct
+70    day_load_energy_84: sensor.foxess_load_energy_today
+71    essential_power: sensor.essential_total_power
+72    nonessential_power: sensor.emontx4_p3
+73    aux_power_166: sensor.aux_total_power
+74    day_pv_energy_108: sensor.foxess_solar_energy_today
+75    pv1_power_186: sensor.foxess_pv1_power
+76    pv2_power_187: sensor.foxess_pv2_power
+77    pv3_power_188: sensor.foxess_pv3_power
+78    pv1_voltage_109: sensor.foxess_pv1_voltage
+79    pv1_current_110: sensor.foxess_pv1_current
+80    pv2_voltage_111: sensor.foxess_pv2_voltage
+81    pv2_current_112: sensor.foxess_pv2_current
+82    pv3_voltage_113: sensor.foxess_pv3_voltage
+83    pv3_current_114: sensor.foxess_pv3_current
+84    nonessential_load1: sensor.emontx4_p3
+85    essential_load1: sensor.emontx4_p8
+86    essential_load2: sensor.kitchen_power
+87    aux_load1: sensor.emontx4_p12
+88    aux_load2: sensor.shlyclkrm_heater_power
+89    aux_load2_extra: sensor.shlycloakroom_temperature_2
+90    energy_cost_buy: sensor.octopus_energy_electricity_xxx_yyy_current_rate
+91    energy_cost_sell: sensor.octopus_energy_electricity_xxx_yyy_export_current_rate
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/examples/goodwe.html b/examples/goodwe.html new file mode 100644 index 00000000..531a44a3 --- /dev/null +++ b/examples/goodwe.html @@ -0,0 +1,253 @@ + + + + + + + Goodwe Inverter — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Goodwe Inverter

+
+

Example 1

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: lite
+ 3panel_mode: false
+ 4large_font: true
+ 5title: Goodwe
+ 6title_colour: grey
+ 7title_size: 32px
+ 8show_solar: true
+ 9show_battery: true
+10show_grid: true
+11inverter:
+12  modern: false
+13  colour: grey
+14  autarky: energy
+15  model: goodwe_gridmode
+16  three_phase: true
+17battery:
+18  energy: 10650
+19  shutdown_soc: sensor.goodwe_shutdown_soc
+20  invert_power: false
+21  show_daily: true
+22  max_power: 5400
+23  show_absolute: false
+24  auto_scale: true
+25solar:
+26  show_daily: true
+27  display_mode: 3
+28  mppts: 2
+29  animation_speed: 9
+30  max_power: 5400
+31  pv1_name: East
+32  pv2_name: West
+33load:
+34  show_daily: true
+35grid:
+36  show_nonessential: true
+37  invert_grid: false
+38  export_colour: green
+39entities:
+40  day_battery_discharge_71: sensor.today_battery_discharge
+41  day_battery_charge_70: sensor.today_battery_charge
+42  day_load_energy_84: sensor.today_load
+43  day_pv_energy_108: sensor.today_s_pv_generation
+44  inverter_voltage_154: sensor.on_grid_l1_voltage
+45  inverter_voltage_L2: sensor.on_grid_l2_voltage
+46  inverter_voltage_L3: sensor.on_grid_l3_voltage
+47  load_frequency_192: sensor.meter_frequency
+48  inverter_current_164: sensor.on_grid_l1_current
+49  inverter_current_L2: sensor.on_grid_l2_current
+50  inverter_current_L3: sensor.on_grid_l3_current
+51  inverter_power_175: zero
+52  pv1_power_186: sensor.pv1_power
+53  pv2_power_187: sensor.pv2_power
+54  pv_total: sensor.pv_power
+55  battery_voltage_183: sensor.battery_voltage
+56  battery_soc_184: sensor.battery_state_of_charge
+57  battery_power_190: sensor.battery_power
+58  battery_current_191: sensor.battery_current
+59  essential_power: sensor.house_consumption
+60  load_power_L1: sensor.load_l1
+61  load_power_L2: sensor.load_l2
+62  load_power_L3: sensor.load_l3
+63  grid_ct_power_172: sensor.active_power_l1
+64  grid_ct_power_L2: sensor.active_power_l2
+65  grid_ct_power_L3: sensor.active_power_l3
+66  grid_ct_power_total: sensor.active_power
+67  pv1_voltage_109: sensor.pv1_voltage
+68  pv1_current_110: sensor.pv1_current
+69  pv2_voltage_111: sensor.pv2_voltage
+70  pv2_current_112: sensor.pv2_current
+71  grid_connected_status_194: sensor.grid_mode_code
+72  inverter_status_59: sensor.work_mode_code
+73  battery_status: sensor.battery_mode_code
+74  total_pv_generation: sensor.total_pv_generation
+75  battery_temp_182: sensor.battery_temperature
+76  radiator_temp_91: sensor.inverter_temperature_radiator
+77  dc_transformer_temp_90: sensor.inverter_temperature_air
+78  day_grid_import_76: sensor.energy_buy_daily
+79  day_grid_export_77: sensor.energy_sell_daily
+80  remaining_solar: sensor.energy_production_today_total
+81  energy_cost_buy: sensor.spot_price_buy
+82  energy_cost_sell: sensor.spot_price_sell
+
+
+
+

Note

+

The Goodwe integration does not provide a sensor for shutdown_soc. +A template sensor can be created using the provided depth of discharge (DOD) sensor i.e number.depth_of_discharge_on_grid. +See example below. Note that the depth of discharge sensor name may vary depending on your HA language.

+
+
- sensor:
+    - name: GoodWe Shutdown SOC
+      unique_id: goodwe_shutdown_soc
+      unit_of_measurement: "%"
+      icon: mdi:battery-arrow-down
+      state: "{{100 - states('number.depth_of_discharge_on_grid') | int }}"
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/examples/huawei.html b/examples/huawei.html new file mode 100644 index 00000000..84240245 --- /dev/null +++ b/examples/huawei.html @@ -0,0 +1,1239 @@ + + + + + + + Huawei Inverter — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Huawei Inverter

+
+

Note

+

Please report all feedback or Issues to the Discussion (Support Sections) of: https://github.com/Roving-Ronin/sunsynk-power-flow-card.

+
+

To use the Sunsynk card with Huawei Solar (or iStore in Australia) you need to copy the huawei_derived_sensors.yaml and sunsynk_card_derived_sensors.yaml files to your /homeassistant/packages directory. Upon restarting Home Assistant this will create all the required derived sensors, based upon the baseline sensors from the WLCRS integration, needed to populate the Sunsynk card. In addition to this, you will need to find an electricity_costs_xxx.yaml file that matches your electricity providers tariff plan, or is similiar and you can customise the ‘Electrity - Price’, ‘Electricity - FIT’ and ‘Energy Meter’ sections to reflect your rate plan costs and usage period(s), all these files are available from: https://github.com/slipx06/sunsynk-power-flow-card/tree/master/docs/examples/huawei_packages.

+

Whilst it would be simplest to create the additional ‘sensor groups’ using yaml files, this has the disadvantage that if later on you want to add or remove devices individual sensors to/from these groups, you are unable to do so by editing them within Home Assistant GUI. Given the flexibility manually creating these sensors groups via the GUI provides, you will need to create the following groups (below) manually. This is done by going to Settings –> Devices & Services –> Helpers, clicking the ‘Create Helper’ button. From the choice of group types then select ‘Sensor Group’ and set the ‘Type’ to SUM. Follow the instructions below for the names to enter for the groups and the member/entities to add into each group.

+ + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + +
REQUIRED MANUALLY CREATED SENSOR GROUPS:

Group Name

Entity ID

Unit of Measurement

+

Purpose

+
+

Sunsynk Card - AUX - Energy Daily

sunsynk_card_aux_energy_daily

kWh

Required for the day_aux_energy entity, that shows the AUX Daily kWh consumed. Group should be populated with the daily energy sensors of all the devices monitored in AUX1 and AUX2

Sunsynk Card - AUX - Active Power

sunsynk_card_aux_active_power

W

Required for the aux_power_166 entity, that shows the total Active Power for AUX1 and AUX2. Group should be populated with the Active Power sensors of all the devices monitored in AUX1 and AUX2

Sunsynk Card - Non Essential - Active Power

sunsynk_card_non_essential_active_power

W

Required for the essential_power entity, that shows the tota Active Power for Non-Essential. Group should be populated with the Active Power sensors of all the non-essntial devices monitored, such as HVAC, EV Charger or Hot Power Pumps.

+
+

To work with the Sunsynk card and the additional derived sensors, some sensors that are disabled by default by the WLCRS integration, must be manually enabled. Listed below the the various devices and the list of sensors for each, that are required to be enabled (at a minimum).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
POWER METER:

Single Phase Installation

Three phase Installation

Active Power

Active Power

Consumption

Consumption

Current

Current

Exported

Exported

Frequency

Frequency

    +
  • +
+

Phase A - Active Power

    +
  • +
+

Phase A - Current

Voltage

Phase A - Voltage

    +
  • +
+

Phase B - Active Power

    +
  • +
+

Phase B - Current

    +
  • +
+

Phase B - Voltage

    +
  • +
+

Phase C - Active Power

    +
  • +
+

Phase C - Current

    +
  • +
+

Phase C - Voltage

Power Factor

Power Factor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
INVERTER(S):

Single Phase Installation

Three Phase Installation

Active Power

Active Power

Daily Yield

Daily Yield

Day Active Peak Power

Day Active Peak Power

Efficiency

Efficiency

Input Power

Input Power

Internal Temperature

Internal Temperature

Phase A Current

Phase A Current

    +
  • +
+

Phase B Current

    +
  • +
+

Phase C Current

PV 1 Current

PV 1 Current

PV 1 Voltage

PV 1 Voltage

PV 2 Current

PV 2 Current

PV 2 Voltage

PV 2 Voltage

Total Yield

Total Yield

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
LUNA ESS BATTERY(S):

Sensor

Comment

Bus Current

    +
  • +
+

Bus Voltage

    +
  • +
+

Capacity Control Periods

Not used currently, future function envisioned

Charge/Discharge Power

    +
  • +
+

Day Charge

    +
  • +
+

Day Discharge

    +
  • +
+

Fixed Charging Periods

    +
  • +
+

State of Capacity

    +
  • +
+

Battery 1 Temperature

    +
  • +
+

Battery 2 Temperature

Optional

Time of Use Periods

Not used currently, future function envisioned

Total Charge

    +
  • +
+

Total Discharge

    +
  • +
+
+

With these sensors active, you can then following the installation instructions for the Sunsynk card, however when you add the card to Home Assistant, change to the ‘Show Code Editor’ view and paste the example code below (that most closely matches your Huawei/iStore setup) into the editor, replacing all the default code shown. Finally, validate the example code copied from below, updating to suite your setup.

+
+
+

Note

+

Data sources for the Sunsynk card is provided by the use of the WLCRS “Huawei Solar” integration - https://github.com/wlcrs/huawei_solar/wiki, as well as the Energy Meter integration https://github.com/zeronounours/HA-custom-component-energy-meter, must be installed prior to installing the Sunsynk card.

+
+
+
+

Example 1 - 1 x L1 1phase inverter with a 15kWh LUNA ESS battery - 2 PV strings (6.6kW)

+
  1type: custom:sunsynk-power-flow-card
+  2cardstyle: full
+  3panel_mode: false
+  4large_font: false
+  5title: Huawei - Power Monitor
+  6title_size: 18px
+  7show_solar: true
+  8show_grid: true
+  9show_battery: true
+ 10decimal_places: 2
+ 11dynamic_line_width: true
+ 12inverter:
+ 13  modern: false
+ 14  colour: grey
+ 15  autarky: power
+ 16  auto_scale: true
+ 17  model: huawei
+ 18  three_phase: false
+ 19battery:
+ 20  energy: 14850
+ 21  shutdown_soc: sensor.battery_end_of_discharge_soc
+ 22  invert_power: true
+ 23  colour: '#fc8d83'
+ 24  show_daily: true
+ 25  animation_speed: 5
+ 26  max_power: 5000
+ 27  show_absolute: true
+ 28  auto_scale: true
+ 29  hide_soc: false
+ 30  show_remaining_energy: true
+ 31  dynamic_colour: true
+ 32  linear_gradient: true
+ 33solar:
+ 34  colour: '#F7BC00'
+ 35  show_daily: true
+ 36  mppts: 2
+ 37  animation_speed: 8
+ 38  max_power: 6600
+ 39  pv1_name: Inv1.S1
+ 40  pv2_name: Inv2.S1
+ 41  display_mode: 2
+ 42  auto_scale: true
+ 43load:
+ 44  colour: magenta
+ 45  show_daily: true
+ 46  show_daily_aux: true
+ 47  show_aux: true
+ 48  invert_aux: false
+ 49  show_absolute_aux: false
+ 50  aux_name: Generator
+ 51  aux_type: gen
+ 52  aux_colour: '#5490c2'
+ 53  aux_off_colour: brown
+ 54  aux_loads: 2
+ 55  aux_load1_name: IT - Servers
+ 56  aux_load2_name: IT - Network
+ 57  aux_load1_icon: mdi:server-network
+ 58  aux_load2_icon: mdi:network
+ 59  animation_speed: 4
+ 60  essential_name: Essential
+ 61  max_power: 4000
+ 62  additional_loads: 2
+ 63  load1_name: Lights
+ 64  load2_name: All GPO
+ 65  load3_name: Spare
+ 66  load4_name: Spare
+ 67  load1_icon: mdi:lightbulb
+ 68  load2_icon: mdi:power-plug
+ 69  load3_icon: mdi:water-boiler
+ 70  load4_icon: mdi:kettle
+ 71  auto_scale: true
+ 72  dynamic_icon: true
+ 73  dynamic_colour: true
+ 74grid:
+ 75  grid_name: Your-Grid-Name
+ 76  colour: '#FF2400'
+ 77  export_colour: green
+ 78  no_grid_colour: '#a40013'
+ 79  grid_off_colour: '#e7d59f'
+ 80  show_daily_buy: true
+ 81  show_daily_sell: true
+ 82  show_nonessential: true
+ 83  invert_grid: true
+ 84  nonessential_name: Non Essential
+ 85  nonessential_icon: none
+ 86  additional_loads: 2
+ 87  load1_name: HVAC
+ 88  load2_name: EV
+ 89  load1_icon: mdi:fan
+ 90  load2_icon: mdi:car
+ 91  animation_speed: 7
+ 92  max_power: 15000
+ 93  auto_scale: true
+ 94  dynamic_icon: true
+ 95  dynamic_colour: true
+ 96  energy_cost_decimals: 3
+ 97entities:
+ 98  use_timer_248: null
+ 99  priority_load_243: null
+100  day_battery_charge_70: sensor.batteries_day_charge
+101  day_battery_discharge_71: sensor.batteries_day_discharge
+102  day_load_energy_84: sensor.house_consumption_energy_daily
+103  day_grid_import_76: sensor.hs_grid_imported_daily
+104  day_grid_export_77: sensor.hs_grid_exported_daily
+105  day_pv_energy_108: sensor.inverters_daily_yield
+106  day_aux_energy: sensor.sunsynk_card_aux_energy_daily
+107  inverter_voltage_154: sensor.power_meter_voltage
+108  load_frequency_192: sensor.power_meter_frequency
+109  grid_power_169: sensor.house_consumption_power
+110  inverter_current_164: sensor.inverter_phase_a_current
+111  inverter_power_175: sensor.inverters_active_power
+112  inverter_status_59: sensor.inverters_state
+113  radiator_temp_91: null
+114  dc_transformer_temp_90: sensor.inverters_internal_temperature
+115  pv1_power_186: sensor.inverter_1_pv_1_power
+116  pv2_power_187: sensor.inverter_1_pv_2_power
+117  pv_total: sensor.inverters_input_power
+118  environment_temp: sensor.<your_location>_temp
+119  remaining_solar: sensor.energy_production_today_remaining
+120  pv1_voltage_109: sensor.inverter_pv_1_voltage
+121  pv1_current_110: sensor.inverter_pv_1_current
+122  pv2_voltage_111: sensor.inverter_pv_2_voltage
+123  pv2_current_112: sensor.inverter_pv_2_current
+124  battery_voltage_183: sensor.batteries_bus_voltage
+125  battery_soc_184: sensor.batteries_state_of_capacity
+126  battery_power_190: sensor.batteries_charge_discharge_power
+127  battery_current_191: sensor.batteries_bus_current
+128  battery_temp_182: sensor.batteries_temperature
+129  battery_status: sensor.batteries_status
+130  essential_power: sensor.house_consumption_power_less_aux_non_essential
+131  essential_load1: sensor.lights_all_active_power
+132  essential_load2: sensor.gpo_all_active_power_less_known
+133  essential_load1_extra: null
+134  essential_load2_extra: null
+135  nonessential_power: sensor.sunsynk_card_non_essential_active_power
+136  non_essential_load1: sensor.hvac_active_power
+137  non_essential_load2: sensor.ev_charger_active_power
+138  grid_ct_power_172: sensor.power_meter_active_power
+139  grid_ct_power_total: sensor.power_meter_active_power
+140  grid_connected_status_194: sensor.inverters_off_grid_status
+141  aux_power_166: sensor.sunsynk_card_aux_active_power
+142  aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status
+143  energy_cost_buy: sensor.electricity_price
+144  energy_cost_sell: sensor.electricity_fit
+145  solar_sell_247: switch.null
+146  aux_load1: sensor.it_hardware_network_active_power
+147  aux_load2: sensor.it_hardware_servers_active_power
+148  aux_load1_extra: sensor.env_network_rack_bme280_temperature
+149  aux_load2_extra: sensor.garage_controller_bme280_temperature
+150  grid_voltage: sensor.power_meter_voltage
+
+
+
+
+

Example 2 - 2 x L1 1phase inverter with a 15kWh LUNA ESS battery - 4 PV strings (13.2kW)

+
  1type: custom:sunsynk-power-flow-card
+  2cardstyle: full
+  3panel_mode: false
+  4large_font: false
+  5title: Huawei - Power Monitor
+  6title_size: 18px
+  7show_solar: true
+  8show_grid: true
+  9show_battery: true
+ 10decimal_places: 2
+ 11inverter:
+ 12  modern: false
+ 13  colour: grey
+ 14  autarky: power
+ 15  auto_scale: true
+ 16  model: huawei
+ 17  three_phase: false
+ 18battery:
+ 19  energy: 14850
+ 20  shutdown_soc: sensor.battery_end_of_discharge_soc
+ 21  invert_power: true
+ 22  colour: '#fc8d83'
+ 23  show_daily: true
+ 24  animation_speed: 5
+ 25  max_power: 5000
+ 26  show_absolute: true
+ 27  auto_scale: true
+ 28  hide_soc: false
+ 29  show_remaining_energy: true
+ 30  dynamic_colour: true
+ 31  linear_gradient: true
+ 32solar:
+ 33  colour: '#F7BC00'
+ 34  show_daily: true
+ 35  mppts: 4
+ 36  animation_speed: 8
+ 37  max_power: 13200
+ 38  pv1_name: Inv1.S1
+ 39  pv2_name: Inv2.S1
+ 40  pv3_name: Inv1.S2
+ 41  pv4_name: Inv2.S2
+ 42  display_mode: 2
+ 43load:
+ 44  colour: magenta
+ 45  show_daily: true
+ 46  show_daily_aux: true
+ 47  show_aux: true
+ 48  invert_aux: false
+ 49  show_absolute_aux: false
+ 50  aux_name: Generator
+ 51  aux_type: gen
+ 52  aux_colour: '#5490c2'
+ 53  aux_off_colour: brown
+ 54  aux_loads: 2
+ 55  aux_load1_name: IT - Servers
+ 56  aux_load2_name: IT - Network
+ 57  aux_load1_icon: mdi:server-network
+ 58  aux_load2_icon: mdi:network
+ 59  animation_speed: 4
+ 60  essential_name: Essential
+ 61  max_power: 4000
+ 62  additional_loads: 2
+ 63  load1_name: Lights
+ 64  load2_name: All GPO
+ 65  load3_name: Spare
+ 66  load4_name: Spare
+ 67  load1_icon: mdi:lightbulb
+ 68  load2_icon: mdi:power-plug
+ 69  load3_icon: mdi:water-boiler
+ 70  load4_icon: mdi:kettle
+ 71  auto_scale: true
+ 72  dynamic_icon: true
+ 73  dynamic_colour: true
+ 74grid:
+ 75  grid_name: Your-Grid-Name
+ 76  colour: '#FF2400'
+ 77  export_colour: green
+ 78  no_grid_colour: '#a40013'
+ 79  grid_off_colour: '#e7d59f'
+ 80  show_daily_buy: true
+ 81  show_daily_sell: true
+ 82  show_nonessential: true
+ 83  invert_grid: true
+ 84  nonessential_name: Non Essential
+ 85  nonessential_icon: none
+ 86  additional_loads: 2
+ 87  load1_name: HVAC
+ 88  load2_name: EV
+ 89  load1_icon: mdi:fan
+ 90  load2_icon: mdi:car
+ 91  animation_speed: 7
+ 92  max_power: 10000
+ 93  auto_scale: true
+ 94  dynamic_icon: true
+ 95  dynamic_colour: true
+ 96  energy_cost_decimals: 3
+ 97entities:
+ 98  use_timer_248: null
+ 99  priority_load_243: null
+100  day_battery_charge_70: sensor.batteries_day_charge
+101  day_battery_discharge_71: sensor.batteries_day_discharge
+102  day_load_energy_84: sensor.house_consumption_energy_daily
+103  day_grid_import_76: sensor.hs_grid_imported_daily
+104  day_grid_export_77: sensor.hs_grid_exported_daily
+105  day_pv_energy_108: sensor.inverters_daily_yield
+106  day_aux_energy: sensor.sunsynk_card_aux_energy_daily
+107  inverter_voltage_154: sensor.power_meter_voltage
+108  load_frequency_192: sensor.power_meter_frequency
+109  inverter_current_164: sensor.inverter_phase_a_current
+110  inverter_power_175: sensor.inverters_active_power
+111  inverter_status_59: sensor.inverters_state
+112  radiator_temp_91: null
+113  dc_transformer_temp_90: sensor.inverters_internal_temperature
+114  pv1_power_186: sensor.inverter_1_pv_1_power
+115  pv2_power_187: sensor.inverter_1_pv_2_power
+116  pv3_power_188: sensor.inverter_2_pv_1_power
+117  pv4_power_189: sensor.inverter_2_pv_2_power
+118  pv_total: sensor.inverters_input_power
+119  environment_temp: sensor.<your_location>_temp
+120  remaining_solar: sensor.energy_production_today_remaining
+121  pv1_voltage_109: sensor.inverter_pv_1_voltage
+122  pv1_current_110: sensor.inverter_pv_1_current
+123  pv2_voltage_111: sensor.inverter_pv_2_voltage
+124  pv2_current_112: sensor.inverter_pv_2_current
+125  pv3_voltage_113: sensor.inverter_pv_1_voltage_2
+126  pv3_current_114: sensor.inverter_pv_1_current_2
+127  pv4_voltage_115: sensor.inverter_pv_2_voltage_2
+128  pv4_current_116: sensor.inverter_pv_2_current_2
+129  battery_voltage_183: sensor.batteries_bus_voltage
+130  battery_soc_184: sensor.batteries_state_of_capacity
+131  battery_power_190: sensor.batteries_charge_discharge_power
+132  battery_current_191: sensor.batteries_bus_current
+133  battery_temp_182: sensor.batteries_temperature
+134  battery_status: sensor.batteries_status
+135  essential_power: sensor.house_consumption_power_less_aux_non_essential
+136  essential_load1: sensor.lights_all_active_power
+137  essential_load2: sensor.gpo_all_active_power_less_known
+138  essential_load1_extra: null
+139  essential_load2_extra: null
+140  nonessential_power: sensor.sunsynk_card_non_essential_active_power
+141  non_essential_load1: sensor.aircon_active_power
+142  non_essential_load2: sensor.ev_charger_active_power
+143  grid_power_169: sensor.house_consumption_power
+144  grid_ct_power_172: sensor.power_meter_active_power
+145  grid_ct_power_total: sensor.power_meter_active_power
+146  grid_connected_status_194: sensor.inverters_off_grid_status
+147  aux_power_166: sensor.sunsynk_card_aux_active_power
+148  aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status
+149  energy_cost_buy: sensor.electricity_price
+150  energy_cost_sell: sensor.electricity_fit
+151  solar_sell_247: switch.null
+152  aux_load1: sensor.it_hardware_network_active_power
+153  aux_load2: sensor.it_hardware_servers_active_power
+154  aux_load1_extra: sensor.env_network_rack_bme280_temperature
+155  aux_load2_extra: sensor.garage_controller_bme280_temperature
+156  grid_voltage: sensor.power_meter_voltage
+
+
+
+
+

Example 3 - 1 x M1 3phase inverter with a 15kWh LUNA ESS battery - 2 PV strings (10kW)

+
  1type: custom:sunsynk-power-flow-card
+  2cardstyle: full
+  3panel_mode: false
+  4large_font: false
+  5title: Huawei - Power Monitor
+  6title_size: 18px
+  7show_solar: true
+  8show_grid: true
+  9show_battery: true
+ 10decimal_places: 2
+ 11dynamic_line_width: true
+ 12inverter:
+ 13  modern: false
+ 14  colour: grey
+ 15  autarky: power
+ 16  auto_scale: true
+ 17  model: huawei
+ 18  three_phase: true
+ 19battery:
+ 20  energy: 14850
+ 21  shutdown_soc: sensor.battery_end_of_discharge_soc
+ 22  invert_power: true
+ 23  colour: '#fc8d83'
+ 24  show_daily: true
+ 25  animation_speed: 5
+ 26  max_power: 5000
+ 27  show_absolute: true
+ 28  auto_scale: true
+ 29  hide_soc: false
+ 30  show_remaining_energy: true
+ 31  dynamic_colour: true
+ 32  linear_gradient: true
+ 33solar:
+ 34  colour: '#F7BC00'
+ 35  show_daily: true
+ 36  mppts: 2
+ 37  animation_speed: 8
+ 38  max_power: 10000
+ 39  pv1_name: Inv1.S1
+ 40  pv2_name: Inv2.S1
+ 41  display_mode: 2
+ 42  auto_scale: true
+ 43load:
+ 44  colour: magenta
+ 45  show_daily: true
+ 46  show_daily_aux: true
+ 47  show_aux: true
+ 48  invert_aux: false
+ 49  show_absolute_aux: false
+ 50  aux_name: Generator
+ 51  aux_type: gen
+ 52  aux_colour: '#5490c2'
+ 53  aux_off_colour: brown
+ 54  aux_loads: 2
+ 55  aux_load1_name: IT - Servers
+ 56  aux_load2_name: IT - Network
+ 57  aux_load1_icon: mdi:server-network
+ 58  aux_load2_icon: mdi:network
+ 59  animation_speed: 4
+ 60  essential_name: Essential
+ 61  max_power: 4000
+ 62  additional_loads: 2
+ 63  load1_name: Lights
+ 64  load2_name: All GPO
+ 65  load3_name: Spare
+ 66  load4_name: Spare
+ 67  load1_icon: mdi:lightbulb
+ 68  load2_icon: mdi:power-plug
+ 69  load3_icon: mdi:water-boiler
+ 70  load4_icon: mdi:kettle
+ 71  auto_scale: true
+ 72  dynamic_icon: true
+ 73  dynamic_colour: true
+ 74grid:
+ 75  grid_name: Your-Grid-Name
+ 76  colour: '#FF2400'
+ 77  export_colour: green
+ 78  no_grid_colour: '#a40013'
+ 79  grid_off_colour: '#e7d59f'
+ 80  show_daily_buy: true
+ 81  show_daily_sell: true
+ 82  show_nonessential: true
+ 83  invert_grid: true
+ 84  nonessential_name: Non Essential
+ 85  nonessential_icon: none
+ 86  additional_loads: 2
+ 87  load1_name: HVAC
+ 88  load2_name: EV
+ 89  load1_icon: mdi:fan
+ 90  load2_icon: mdi:car
+ 91  animation_speed: 7
+ 92  max_power: 25000
+ 93  auto_scale: true
+ 94  dynamic_icon: true
+ 95  dynamic_colour: true
+ 96  energy_cost_decimals: 3
+ 97entities:
+ 98  use_timer_248: null
+ 99  priority_load_243: null
+100  day_battery_charge_70: sensor.batteries_day_charge
+101  day_battery_discharge_71: sensor.batteries_day_discharge
+102  day_load_energy_84: sensor.house_consumption_energy_daily
+103  day_grid_import_76: sensor.hs_grid_imported_daily
+104  day_grid_export_77: sensor.hs_grid_exported_daily
+105  day_pv_energy_108: sensor.inverters_daily_yield
+106  day_aux_energy: sensor.sunsynk_card_aux_energy_daily
+107  inverter_voltage_154: sensor.power_meter_phase_a_voltage
+108  inverter_voltage_L2: sensor.power_meter_phase_b_voltage
+109  inverter_voltage_L3: sensor.power_meter_phase_c_voltage
+110  load_frequency_192: sensor.power_meter_frequency
+111  grid_power_169: sensor.house_consumption_power
+112  inverter_current_164: sensor.inverter_phase_a_current
+113  inverter_current_L2: sensor.inverter_phase_b_current
+114  inverter_current_L3: sensor.inverter_phase_c_current
+115  inverter_power_175: sensor.inverters_active_power
+116  inverter_status_59: sensor.inverters_state
+117  radiator_temp_91: null
+118  dc_transformer_temp_90: sensor.inverters_internal_temperature
+119  pv1_power_186: sensor.inverter_1_pv_1_power
+120  pv2_power_187: sensor.inverter_1_pv_2_power
+121  pv_total: sensor.inverters_input_power
+122  environment_temp: sensor.<your_location>_temp
+123  remaining_solar: sensor.energy_production_today_remaining
+124  pv1_voltage_109: sensor.inverter_pv_1_voltage
+125  pv1_current_110: sensor.inverter_pv_1_current
+126  pv2_voltage_111: sensor.inverter_pv_2_voltage
+127  pv2_current_112: sensor.inverter_pv_2_current
+128  battery_voltage_183: sensor.batteries_bus_voltage
+129  battery_soc_184: sensor.batteries_state_of_capacity
+130  battery_power_190: sensor.batteries_charge_discharge_power
+131  battery_current_191: sensor.batteries_bus_current
+132  battery_temp_182: sensor.batteries_temperature
+133  battery_status: sensor.batteries_status
+134  essential_power: sensor.house_consumption_power_less_aux_non_essential
+135  essential_load1: sensor.lights_all_active_power
+136  essential_load2: sensor.gpo_all_active_power_less_known
+137  essential_load1_extra: null
+138  essential_load2_extra: null
+139  load_power_L1: sensor.shelly3em_phase_a_gpo_power
+140  load_power_L2: sensor.shelly3em_phase_b_gpo_power
+141  load_power_L3: sensor.shelly3em_phase_c_gpo_power
+142  nonessential_power: sensor.sunsynk_card_non_essential_active_power
+143  non_essential_load1: sensor.hvac_active_power
+144  non_essential_load2: sensor.ev_charger_active_power
+145  grid_ct_power_172: sensor.power_meter_phase_a_active_power
+146  grid_ct_power_L2: sensor.power_meter_phase_b_active_power
+147  grid_ct_power_L3: sensor.power_meter_phase_c_active_power
+148  grid_ct_power_total: sensor.power_meter_active_power
+149  grid_connected_status_194: sensor.inverters_off_grid_status
+150  aux_power_166: sensor.sunsynk_card_aux_active_power
+151  aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status
+152  energy_cost_buy: sensor.electricity_price
+153  energy_cost_sell: sensor.electricity_fit
+154  solar_sell_247: switch.null
+155  aux_load1: sensor.it_hardware_network_active_power
+156  aux_load2: sensor.it_hardware_servers_active_power
+157  aux_load1_extra: sensor.env_network_rack_bme280_temperature
+158  aux_load2_extra: sensor.garage_controller_bme280_temperature
+159  grid_voltage: sensor.power_meter_voltage
+
+
+
+
+

Example 4 - 1 x M1 3phase inverters with 2 x 15kWh LUNA ESS batteries - 2 PV strings (10kW)

+
  1type: custom:sunsynk-power-flow-card
+  2cardstyle: full
+  3panel_mode: false
+  4large_font: false
+  5title: Huawei - Power Monitor
+  6title_size: 18px
+  7show_solar: true
+  8show_grid: true
+  9show_battery: true
+ 10decimal_places: 2
+ 11dynamic_line_width: true
+ 12inverter:
+ 13  modern: false
+ 14  colour: grey
+ 15  autarky: power
+ 16  auto_scale: true
+ 17  model: huawei
+ 18  three_phase: true
+ 19battery:
+ 20  energy: 29700
+ 21  shutdown_soc: sensor.battery_end_of_discharge_soc
+ 22  invert_power: true
+ 23  colour: '#fc8d83'
+ 24  show_daily: true
+ 25  animation_speed: 5
+ 26  max_power: 10000
+ 27  show_absolute: true
+ 28  auto_scale: true
+ 29  hide_soc: false
+ 30  show_remaining_energy: true
+ 31  dynamic_colour: true
+ 32  linear_gradient: true
+ 33solar:
+ 34  colour: '#F7BC00'
+ 35  show_daily: true
+ 36  mppts: 2
+ 37  animation_speed: 8
+ 38  max_power: 10000
+ 39  pv1_name: Inv1.S1
+ 40  pv2_name: Inv2.S1
+ 41  display_mode: 2
+ 42  auto_scale: true
+ 43load:
+ 44  colour: magenta
+ 45  show_daily: true
+ 46  show_daily_aux: true
+ 47  show_aux: true
+ 48  invert_aux: false
+ 49  show_absolute_aux: false
+ 50  aux_name: Generator
+ 51  aux_type: gen
+ 52  aux_colour: '#5490c2'
+ 53  aux_off_colour: brown
+ 54  aux_loads: 2
+ 55  aux_load1_name: IT - Servers
+ 56  aux_load2_name: IT - Network
+ 57  aux_load1_icon: mdi:server-network
+ 58  aux_load2_icon: mdi:network
+ 59  animation_speed: 4
+ 60  essential_name: Essential
+ 61  max_power: 4000
+ 62  additional_loads: 2
+ 63  load1_name: Lights
+ 64  load2_name: All GPO
+ 65  load3_name: Spare
+ 66  load4_name: Spare
+ 67  load1_icon: mdi:lightbulb
+ 68  load2_icon: mdi:power-plug
+ 69  load3_icon: mdi:water-boiler
+ 70  load4_icon: mdi:kettle
+ 71  auto_scale: true
+ 72  dynamic_icon: true
+ 73  dynamic_colour: true
+ 74grid:
+ 75  grid_name: Your-Grid-Name
+ 76  colour: '#FF2400'
+ 77  export_colour: green
+ 78  no_grid_colour: '#a40013'
+ 79  grid_off_colour: '#e7d59f'
+ 80  show_daily_buy: true
+ 81  show_daily_sell: true
+ 82  show_nonessential: true
+ 83  invert_grid: true
+ 84  nonessential_name: Non Essential
+ 85  nonessential_icon: none
+ 86  additional_loads: 2
+ 87  load1_name: HVAC
+ 88  load2_name: EV
+ 89  load1_icon: mdi:fan
+ 90  load2_icon: mdi:car
+ 91  animation_speed: 7
+ 92  max_power: 25000
+ 93  auto_scale: true
+ 94  dynamic_icon: true
+ 95  dynamic_colour: true
+ 96  energy_cost_decimals: 3
+ 97entities:
+ 98  use_timer_248: null
+ 99  priority_load_243: null
+100  day_battery_charge_70: sensor.batteries_day_charge
+101  day_battery_discharge_71: sensor.batteries_day_discharge
+102  day_load_energy_84: sensor.house_consumption_energy_daily
+103  day_grid_import_76: sensor.hs_grid_imported_daily
+104  day_grid_export_77: sensor.hs_grid_exported_daily
+105  day_pv_energy_108: sensor.inverters_daily_yield
+106  day_aux_energy: sensor.sunsynk_card_aux_energy_daily
+107  inverter_voltage_154: sensor.power_meter_phase_a_voltage
+108  inverter_voltage_L2: sensor.power_meter_phase_b_voltage
+109  inverter_voltage_L3: sensor.power_meter_phase_c_voltage
+110  load_frequency_192: sensor.power_meter_frequency
+111  grid_power_169: sensor.house_consumption_power
+112  inverter_current_164: sensor.inverter_phase_a_current
+113  inverter_current_L2: sensor.inverter_phase_b_current
+114  inverter_current_L3: sensor.inverter_phase_c_current
+115  inverter_power_175: sensor.inverters_active_power
+116  inverter_status_59: sensor.inverters_state
+117  radiator_temp_91: null
+118  dc_transformer_temp_90: sensor.inverters_internal_temperature
+119  pv1_power_186: sensor.inverter_1_pv_1_power
+120  pv2_power_187: sensor.inverter_1_pv_2_power
+121  pv3_power_188: sensor.inverter_2_pv_1_power
+122  pv4_power_189: sensor.inverter_2_pv_2_power
+123  pv_total: sensor.inverters_input_power
+124  environment_temp: sensor.<your_location>_temp
+125  remaining_solar: sensor.energy_production_today_remaining
+126  pv1_voltage_109: sensor.inverter_pv_1_voltage
+127  pv1_current_110: sensor.inverter_pv_1_current
+128  pv2_voltage_111: sensor.inverter_pv_2_voltage
+129  pv2_current_112: sensor.inverter_pv_2_current
+130  battery_voltage_183: sensor.batteries_bus_voltage
+131  battery_soc_184: sensor.batteries_state_of_capacity
+132  battery_power_190: sensor.batteries_charge_discharge_power
+133  battery_current_191: sensor.batteries_bus_current
+134  battery_temp_182: sensor.batteries_temperature
+135  battery_status: sensor.batteries_status
+136  essential_power: sensor.house_consumption_power_less_aux_non_essential
+137  essential_load1: sensor.lights_all_active_power
+138  essential_load2: sensor.gpo_all_active_power_less_known
+139  essential_load1_extra: null
+140  essential_load2_extra: null
+141  load_power_L1: sensor.shelly3em_phase_a_gpo_power
+142  load_power_L2: sensor.shelly3em_phase_b_gpo_power
+143  load_power_L3: sensor.shelly3em_phase_c_gpo_power
+144  nonessential_power: sensor.sunsynk_card_non_essential_active_power
+145  non_essential_load1: sensor.hvac_active_power
+146  non_essential_load2: sensor.ev_charger_active_power
+147  grid_ct_power_172: sensor.power_meter_phase_a_active_power
+148  grid_ct_power_L2: sensor.power_meter_phase_b_active_power
+149  grid_ct_power_L3: sensor.power_meter_phase_c_active_power
+150  grid_ct_power_total: sensor.power_meter_active_power
+151  grid_connected_status_194: sensor.inverters_off_grid_status
+152  aux_power_166: sensor.sunsynk_card_aux_active_power
+153  aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status
+154  energy_cost_buy: sensor.electricity_price
+155  energy_cost_sell: sensor.electricity_fit
+156  solar_sell_247: switch.null
+157  aux_load1: sensor.it_hardware_network_active_power
+158  aux_load2: sensor.it_hardware_servers_active_power
+159  aux_load1_extra: sensor.env_network_rack_bme280_temperature
+160  aux_load2_extra: sensor.garage_controller_bme280_temperature
+161  grid_voltage: sensor.power_meter_voltage
+
+
+
+
+

Example 5 - 2 x M1 3phase inverters with a 15kWh LUNA ESS battery - 4 PV strings (20kW)

+
  1type: custom:sunsynk-power-flow-card
+  2cardstyle: full
+  3panel_mode: false
+  4large_font: false
+  5title: Huawei - Power Monitor
+  6title_size: 18px
+  7show_solar: true
+  8show_grid: true
+  9show_battery: true
+ 10decimal_places: 2
+ 11dynamic_line_width: true
+ 12inverter:
+ 13  modern: false
+ 14  colour: grey
+ 15  autarky: power
+ 16  auto_scale: true
+ 17  model: huawei
+ 18  three_phase: true
+ 19battery:
+ 20  energy: 14850
+ 21  shutdown_soc: sensor.battery_end_of_discharge_soc
+ 22  invert_power: true
+ 23  colour: '#fc8d83'
+ 24  show_daily: true
+ 25  animation_speed: 5
+ 26  max_power: 5000
+ 27  show_absolute: true
+ 28  auto_scale: true
+ 29  hide_soc: false
+ 30  show_remaining_energy: true
+ 31  dynamic_colour: true
+ 32  linear_gradient: true
+ 33solar:
+ 34  colour: '#F7BC00'
+ 35  show_daily: true
+ 36  mppts: 4
+ 37  animation_speed: 8
+ 38  max_power: 20000
+ 39  pv1_name: Inv1.S1
+ 40  pv2_name: Inv2.S1
+ 41  pv3_name: Inv1.S2
+ 42  pv4_name: Inv2.S2
+ 43  display_mode: 2
+ 44  auto_scale: true
+ 45load:
+ 46  colour: magenta
+ 47  show_daily: true
+ 48  show_daily_aux: true
+ 49  show_aux: true
+ 50  invert_aux: false
+ 51  show_absolute_aux: false
+ 52  aux_name: Generator
+ 53  aux_type: gen
+ 54  aux_colour: '#5490c2'
+ 55  aux_off_colour: brown
+ 56  aux_loads: 2
+ 57  aux_load1_name: IT - Servers
+ 58  aux_load2_name: IT - Network
+ 59  aux_load1_icon: mdi:server-network
+ 60  aux_load2_icon: mdi:network
+ 61  animation_speed: 4
+ 62  essential_name: Essential
+ 63  max_power: 4000
+ 64  additional_loads: 2
+ 65  load1_name: Lights
+ 66  load2_name: All GPO
+ 67  load3_name: Spare
+ 68  load4_name: Spare
+ 69  load1_icon: mdi:lightbulb
+ 70  load2_icon: mdi:power-plug
+ 71  load3_icon: mdi:water-boiler
+ 72  load4_icon: mdi:kettle
+ 73  auto_scale: true
+ 74  dynamic_icon: true
+ 75  dynamic_colour: true
+ 76grid:
+ 77  grid_name: Your-Grid-Name
+ 78  colour: '#FF2400'
+ 79  export_colour: green
+ 80  no_grid_colour: '#a40013'
+ 81  grid_off_colour: '#e7d59f'
+ 82  show_daily_buy: true
+ 83  show_daily_sell: true
+ 84  show_nonessential: true
+ 85  invert_grid: true
+ 86  nonessential_name: Non Essential
+ 87  nonessential_icon: none
+ 88  additional_loads: 2
+ 89  load1_name: HVAC
+ 90  load2_name: EV
+ 91  load1_icon: mdi:fan
+ 92  load2_icon: mdi:car
+ 93  animation_speed: 7
+ 94  max_power: 25000
+ 95  auto_scale: true
+ 96  dynamic_icon: true
+ 97  dynamic_colour: true
+ 98  energy_cost_decimals: 3
+ 99entities:
+100  use_timer_248: null
+101  priority_load_243: null
+102  day_battery_charge_70: sensor.batteries_day_charge
+103  day_battery_discharge_71: sensor.batteries_day_discharge
+104  day_load_energy_84: sensor.house_consumption_energy_daily
+105  day_grid_import_76: sensor.hs_grid_imported_daily
+106  day_grid_export_77: sensor.hs_grid_exported_daily
+107  day_grid_export_77: sensor.hs_grid_exported_daily
+108  day_grid_export_77: sensor.hs_grid_exported_daily
+109  day_pv_energy_108: sensor.inverters_daily_yield
+110  day_aux_energy: sensor.sunsynk_card_aux_energy_daily
+111  inverter_voltage_154: sensor.power_meter_phase_a_voltage
+112  inverter_voltage_L2: sensor.power_meter_phase_b_voltage
+113  inverter_voltage_L3: sensor.power_meter_phase_c_voltage
+114  load_frequency_192: sensor.power_meter_frequency
+115  grid_power_169: sensor.house_consumption_power
+116  inverter_current_164: sensor.inverter_phase_a_current
+117  inverter_current_L2: sensor.inverter_phase_b_current
+118  inverter_current_L3: sensor.inverter_phase_c_current
+119  inverter_power_175: sensor.inverters_active_power
+120  inverter_status_59: sensor.inverters_state
+121  radiator_temp_91: null
+122  dc_transformer_temp_90: sensor.inverters_internal_temperature
+123  pv1_power_186: sensor.inverter_1_pv_1_power
+124  pv2_power_187: sensor.inverter_1_pv_2_power
+125  pv3_power_188: sensor.inverter_2_pv_1_power
+126  pv4_power_189: sensor.inverter_2_pv_2_power
+127  pv_total: sensor.inverters_input_power
+128  environment_temp: sensor.<your_location>_temp
+129  remaining_solar: sensor.energy_production_today_remaining
+130  pv1_voltage_109: sensor.inverter_pv_1_voltage
+131  pv1_current_110: sensor.inverter_pv_1_current
+132  pv2_voltage_111: sensor.inverter_pv_2_voltage
+133  pv2_current_112: sensor.inverter_pv_2_current
+134  pv3_voltage_113: sensor.inverter_pv_1_voltage_2
+135  pv3_current_114: sensor.inverter_pv_1_current_2
+136  pv4_voltage_115: sensor.inverter_pv_2_voltage_2
+137  pv4_current_116: sensor.inverter_pv_2_current_2
+138  battery_voltage_183: sensor.batteries_bus_voltage
+139  battery_soc_184: sensor.batteries_state_of_capacity
+140  battery_power_190: sensor.batteries_charge_discharge_power
+141  battery_current_191: sensor.batteries_bus_current
+142  battery_temp_182: sensor.batteries_temperature
+143  battery_status: sensor.batteries_status
+144  essential_power: sensor.house_consumption_power_less_aux_non_essential
+145  essential_load1: sensor.lights_all_active_power
+146  essential_load2: sensor.gpo_all_active_power_less_known
+147  essential_load1_extra: null
+148  essential_load2_extra: null
+149  load_power_L1: sensor.shelly3em_phase_a_gpo_power
+150  load_power_L2: sensor.shelly3em_phase_b_gpo_power
+151  load_power_L3: sensor.shelly3em_phase_c_gpo_power
+152  nonessential_power: sensor.sunsynk_card_non_essential_active_power
+153  non_essential_load1: sensor.hvac_active_power
+154  non_essential_load2: sensor.ev_charger_active_power
+155  grid_ct_power_172: sensor.power_meter_phase_a_active_power
+156  grid_ct_power_L2: sensor.power_meter_phase_b_active_power
+157  grid_ct_power_L3: sensor.power_meter_phase_c_active_power
+158  grid_ct_power_total: sensor.power_meter_active_power
+159  grid_connected_status_194: sensor.inverters_off_grid_status
+160  aux_power_166: sensor.sunsynk_card_aux_active_power
+161  aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status
+162  energy_cost_buy: sensor.electricity_price
+163  energy_cost_sell: sensor.electricity_fit
+164  solar_sell_247: switch.null
+165  aux_load1: sensor.it_hardware_network_active_power
+166  aux_load2: sensor.it_hardware_servers_active_power
+167  aux_load1_extra: sensor.env_network_rack_bme280_temperature
+168  aux_load2_extra: sensor.garage_controller_bme280_temperature
+169  grid_voltage: sensor.power_meter_voltage
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/examples/lux.html b/examples/lux.html new file mode 100644 index 00000000..b593d386 --- /dev/null +++ b/examples/lux.html @@ -0,0 +1,277 @@ + + + + + + + Lux Inverter — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Lux Inverter

+
+

Example 1

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: lite
+ 3show_solar: true
+ 4inverter:
+ 5  model: lux
+ 6battery:
+ 7  show: true
+ 8  energy: 12800
+ 9  shutdown_soc: 1
+10  show_daily: true
+11  invert_power: true
+12solar:
+13  show_daily: true
+14  mppts: 2
+15  pv1_name: Rear
+16  pv2_name: Front
+17load:
+18  show_daily: true
+19grid:
+20  show_daily_buy: true
+21  show_daily_sell: true
+22  show_nonessential: false
+23  invert_grid: true
+24  additional_loads: 2
+25entities:
+26  inverter_voltage_154: sensor.lux_grid_voltage_live
+27  load_frequency_192: sensor.lux_grid_frequency_live
+28  inverter_current_164: sensor.inverter_output_current
+29  inverter_status_59: sensor.lux_status
+30  inverter_power_175: sensor.lux_battery_flow_live
+31  day_battery_charge_70: sensor.lux_battery_charge_daily
+32  day_battery_discharge_71: sensor.lux_battery_discharge_daily
+33  battery_voltage_183: sensor.lux_battery_voltage_live
+34  battery_soc_184: sensor.lux_battery
+35  battery_power_190: sensor.lux_battery_flow_live
+36  battery_current_191: sensor.lux_battery_capacity_ah
+37  grid_power_169: sensor.lux_grid_flow_live
+38  day_grid_import_76: sensor.lux_power_from_grid_daily
+39  day_grid_export_77: sensor.lux_power_to_grid_daily
+40  grid_ct_power_172: sensor.lux_grid_flow_live
+41  day_load_energy_84: sensor.lux_power_from_inverter_to_home_daily
+42  essential_power: sensor.lux_home_consumption_live
+43  nonessential_power: none
+44  aux_power_166: sensor.aux_output_power
+45  day_pv_energy_108: sensor.lux_solar_output_daily
+46  pv_total: sensor.lux_solar_output_live
+47  pv1_power_186: sensor.lux_solar_output_array_1_live
+48  pv2_power_187: sensor.lux_solar_output_array_2_live
+49  pv1_voltage_109: sensor.lux_solar_voltage_array_1_live
+50  pv1_current_110: none
+51  pv2_voltage_111: sensor.lux_solar_voltage_array_2_live
+52  pv2_current_112: none
+53  radiator_temp_91: sensor.lux_radiator_1_temperature_live
+54  dc_transformer_temp_90: sensor.lux_radiator_2_temperature_live
+55  remaining_solar: sensor.forecast_remaining_today
+56  energy_cost: sensor.octopus_energy_electricity_20e5081533_2380002009185_current_rate
+
+
+
+
+

Example 2 using the lxp-bridge integration (https://github.com/celsworth/lxp-bridge)

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: lite
+ 3show_solar: true
+ 4inverter:
+ 5  model: lux
+ 6battery:
+ 7  energy: 12800
+ 8  shutdown_soc: 20
+ 9  show_daily: true
+10  invert_power: true
+11solar:
+12  show_daily: true
+13  mppts: 2
+14  pv1_name: PV1
+15  pv2_name: PV2
+16load:
+17  show_daily: true
+18grid:
+19  show_daily_buy: true
+20  show_daily_sell: true
+21  show_nonessential: false
+22  invert_grid: true
+23  additional_loads: 0
+24entities:
+25  inverter_voltage_154: sensor.lxp_baXXXXXXXX_grid_voltage
+26  load_frequency_192: sensor.lxp_baXXXXXXXX_eps_frequency
+27  inverter_current_164: NONE
+28  inverter_status_59: NONE
+29  inverter_power_175: sensor.lxp_baXXXXXXXX_inverter_power
+30  day_battery_charge_70: sensor.lxp_baXXXXXXXX_battery_charge_today
+31  day_battery_discharge_71: sensor.lxp_baXXXXXXXX_battery_discharge_today
+32  battery_voltage_183: sensor.lxp_baXXXXXXXX_battery_voltage
+33  battery_soc_184: sensor.lxp_baXXXXXXXX_battery_percentage
+34  battery_power_190: sensor.lxp_baXXXXXXXX_battery_power_discharge_is_negative
+35  battery_current_191: NONE
+36  grid_power_169: sensor.lxp_baXXXXXXXX_grid_power_export_is_negative
+37  day_grid_import_76: sensor.lxp_baXXXXXXXX_energy_from_grid_today
+38  day_grid_export_77: sensor.lxp_baXXXXXXXX_energy_to_grid_today
+39  grid_ct_power_172: NONE
+40  day_load_energy_84: sensor.lxp_baXXXXXXXX_energy_of_inverter_today
+41  essential_power: sensor.lxp_baXXXXXXXX_inverter_power
+42  nonessential_power: NONE
+43  aux_power_166: NONE
+44  day_pv_energy_108: sensor.lxp_baXXXXXXXX_pv_generation_today
+45  pv_total: sensor.lxp_baXXXXXXXX_power_pv_array
+46  pv1_power_186: sensor.lxp_baXXXXXXXX_power_pv_string_1
+47  pv2_power_187: sensor.lxp_baXXXXXXXX_power_pv_string_2
+48  pv1_voltage_109: sensor.lxp_baXXXXXXXX_voltage_pv_string_1
+49  pv1_current_110: NONE
+50  pv2_voltage_111: sensor.lxp_baXXXXXXXX_voltage_pv_string_2
+51  pv2_current_112: NONE
+52  radiator_temp_91: sensor.lxp_baXXXXXXXX_radiator_1_temperature
+53  dc_transformer_temp_90: sensor.lxp_baXXXXXXXX_radiator_2_temperature
+54  remaining_solar: sensor.forecast_remaining_today
+55  energy_cost: NONE
+
+
+
+

Note

+

Replace baXXXXXXXX with your wifi dongle number

+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/examples/solax.html b/examples/solax.html new file mode 100644 index 00000000..799a9a4c --- /dev/null +++ b/examples/solax.html @@ -0,0 +1,236 @@ + + + + + + + SolaX Inverter — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

SolaX Inverter

+
+

Example 1

+
 1  type: custom:sunsynk-power-flow-card
+ 2  cardstyle: compact
+ 3  show_solar: true
+ 4  show_grid: true
+ 5  show_battery: true
+ 6  large_font: false
+ 7  panel_mode: false
+ 8  inverter:
+ 9    auto_scale: false
+10    modern: false
+11    model: solax
+12  battery:
+13    energy: 17600
+14    shutdown_soc: 11
+15    show_daily: true
+16    invert_power: true
+17    max_power: 3750
+18    auto_scale: false
+19    show_absolute: false
+20    hide_soc: false
+21  solar:
+22    show_daily: true
+23    mppts: 1
+24    max_power: 7000
+25    display_mode: 2
+26    animation_speed: 9
+27    dynamic_colour: false
+28  load:
+29    show_daily: true
+30    max_power: 15000
+31    show_aux: false
+32    show_nonessential: true
+33    additional_loads: 2
+34    load1_name: Water
+35    load2_name: EV
+36    load1_icon: mdi:thermometer-water
+37    load2_icon: mdi:ev-station
+38    animation_speed: 9
+39  grid:
+40    show_daily_buy: true
+41    show_daily_sell: true
+42    show_nonessential: false
+43    animation_speed: 9
+44    auto_scale: false
+45    export_colour:
+46      - 194
+47      - 6
+48      - 219
+49    no_grid_colour:
+50      - 189
+51      - 188
+52      - 188
+53  entities:
+54    inverter_status_59: sensor.solax_run_mode
+55    inverter_voltage_154: sensor.solax_inverter_voltage
+56    inverter_current_164: sensor.solax_inverter_current
+57    inverter_power_175: sensor.solax_inverter_power
+58    radiator_temp_91: sensor.solax_inverter_temperature
+59    day_battery_charge_70: sensor.solax_battery_input_energy_today
+60    day_battery_discharge_71: sensor.solax_battery_output_energy_today
+61    battery_voltage_183: sensor.solax_battery_voltage_charge
+62    battery_soc_184: sensor.solax_battery_capacity
+63    battery_power_190: sensor.solax_battery_power_charge
+64    battery_current_191: sensor.solax_battery_current_charge
+65    battery_temp_182: sensor.solax_battery_temperature
+66    day_grid_import_76: sensor.solax_today_s_import_energy
+67    day_grid_export_77: sensor.solax_today_s_export_energy
+68    grid_power_169: sensor.solax_grid_export_import_sum2
+69    grid_ct_power_172: sensor.solax_grid_export_import_sum2
+70    day_load_energy_84: sensor.powerflow_today_house_load
+71    day_pv_energy_108: sensor.solax_today_s_solar_energy
+72    pv1_power_186: sensor.solax_pv_power_1
+73    pv1_voltage_109: sensor.solax_pv_voltage_1
+74    pv1_current_110: sensor.solax_pv_current_1
+75    remaining_solar: sensor.solcast_pv_forecast_forecast_remaining_today
+76    essential_load1: sensor.immersion_current_consumption
+77    essential_load1_extra: sensor.immersion_energy_day
+78    essential_load2: sensor.ev_power_consumption
+79    essential_load2_extra: sensor.ev_fast_charge_day
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/examples/solis.html b/examples/solis.html new file mode 100644 index 00000000..41df824c --- /dev/null +++ b/examples/solis.html @@ -0,0 +1,342 @@ + + + + + + + Solis Inverter — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Solis Inverter

+
+

Example 1 - Integration via https://github.com/wills106/homeassistant-solax-modbus

+
 1  type: custom:sunsynk-power-flow-card
+ 2  cardstyle: lite
+ 3  show_solar: true
+ 4  large_font: true
+ 5  inverter:
+ 6    modern: true
+ 7    autarky: energy
+ 8  battery:
+ 9    energy: 14400
+10    shutdown_soc: 20
+11    show_daily: true
+12  solar:
+13    show_daily: true
+14    mppts: 1
+15  load:
+16    show_daily: true
+17    additional_loads: 2
+18    load1_name: PC
+19    load1_icon: mdi:desktop-classic
+20    load2_name: TV
+21    load2_icon: mdi:television
+22  grid:
+23    show_daily_buy: true
+24    show_daily_sell: true
+25    show_nonessential: false
+26  entities:
+27    grid_power_167: sensor.solis_inverter_meter_active_power
+28    essential_power: sensor.solis_inverter_house_load
+29    essential_load1: sensor.pc_socket_power
+30    essential_load2: sensor.smart_socket_3_power
+31    energy_cost_buy: sensor.octopus_energy_electricity_xxxxx_xxxxxx_current_rate
+32    energy_cost_sell: sensor.octopus_energy_electricity_xxxxxx_xxxxx_export_current_rate
+33    remaining_solar: sensor.energy_production_today_remaining
+34    radiator_temp_91: sensor.solis_inverter_inverter_temperature
+35    use_timer_248: switch.sunsynk_toggle_system_timer
+36    inverter_voltage_154: sensor.solis_inverter_inverter_voltage
+37    load_frequency_192: sensor.solis_inverter_inverter_frequency
+38    inverter_current_164: sensor.solis_inverter_inverter_current
+39    inverter_power_175: sensor.solis_inverter_active_power
+40    day_battery_charge_70: sensor.solis_inverter_battery_charge_today
+41    day_battery_discharge_71: sensor.solis_inverter_battery_discharge_today
+42    battery_voltage_183: sensor.solis_inverter_battery_voltage
+43    battery_soc_184: sensor.solis_inverter_battery_soc
+44    battery_power_190: sensor.battery_load
+45    battery_current_191: sensor.solis_inverter_battery_current
+46    day_grid_import_76: sensor.solis_inverter_grid_import_today
+47    day_grid_export_77: sensor.solis_inverter_grid_export_today
+48    grid_ct_power_172: sensor.solis_inverter_meter_active_power
+49    day_load_energy_84: sensor.solis_inverter_house_load_today
+50    day_pv_energy_108: sensor.solis_inverter_power_generation_today
+51    pv1_power_186: sensor.solis_inverter_pv_total_power
+52    pv1_voltage_109: sensor.solis_inverter_pv_voltage_1
+53    pv1_current_110: sensor.solis_inverter_pv_current_1
+
+
+
+
+

Example 2 (Solis S6 or S2-WL-ST) - Integration via https://github.com/Pho3niX90/solis_modbus

+
 1  type: custom:sunsynk-power-flow-card
+ 2  view_layout:
+ 3    grid-area: flow
+ 4  cardstyle: lite
+ 5  large_font: true
+ 6  show_solar: true
+ 7  panel_mode: true
+ 8  card_height: 415px
+ 9  inverter:
+10    model: solis
+11    modern: false
+12    colour: '#959595'
+13    autarky: 'no'
+14  solar:
+15    mppts: 2
+16    show_daily: false
+17    colour: '#F4C430'
+18    animation_speed: 9
+19    max_power: 9600
+20    pv1_name: West
+21    pv2_name: North
+22  battery:
+23    energy: 14280
+24    shutdown_soc: 20
+25    show_daily: true
+26    colour: pink
+27    animation_speed: 6
+28    max_power: 6000
+29  load:
+30    show_aux: false
+31    show_daily: true
+32    animation_speed: 8
+33    max_power: 6000
+34    additional_loads: 2
+35    load2_name: Geyser
+36    load2_icon: mdi:heating-coil
+37    load1_name: Pool
+38    load1_icon: mdi:pool
+39  grid:
+40    show_daily_buy: true
+41    no_grid_colour: red
+42    animation_speed: 8
+43    max_power: 6000
+44    invert_grid: true
+45  entities:
+46    dc_transformer_temp_90: sensor.solis_inverter_temperature
+47    day_battery_charge_70: sensor.solis_inverter_today_battery_charge_energy
+48    day_battery_discharge_71: sensor.solis_inverter_today_battery_discharge_energy
+49    day_load_energy_84: sensor.solis_inverter_today_energy_consumption
+50    day_grid_import_76: sensor.solis_inverter_today_energy_imported_from_grid
+51    day_grid_export_77: sensor.solis_inverter_today_energy_fed_into_grid
+52    day_pv_energy_108: sensor.solis_inverter_pv_today_energy_generation
+53    inverter_voltage_154: sensor.solis_inverter_a_phase_voltage
+54    load_frequency_192: sensor.solis_inverter_grid_frequency
+55    inverter_current_164: sensor.solis_inverter_a_phase_current
+56    inverter_power_175: sensor.solis_inverter_backup_load_power
+57    grid_power_169: sensor.solis_inverter_ac_grid_port_power
+58    battery_voltage_183: sensor.solis_inverter_battery_voltage
+59    battery_soc_184: sensor.solis_inverter_battery_soc
+60    battery_power_190: sensor.solis_inverter_battery_power
+61    battery_current_191: sensor.solis_inverter_battery_current
+62    essential_power: sensor.solis_inverter_backup_load_power
+63    grid_ct_power_172: sensor.solis_inverter_meter_total_active_power
+64    pv1_voltage_109: sensor.solis_inverter_dc_voltage_1
+65    pv1_current_110: sensor.solis_inverter_dc_current_1
+66    pv1_power_186: sensor.solis_inverter_dc_power_1
+67    pv2_voltage_111: sensor.solis_inverter_dc_voltage_2
+68    pv2_current_112: sensor.solis_inverter_dc_current_2
+69    pv2_power_187: sensor.solis_inverter_dc_power_2
+70    pv_total: sensor.solis_inverter_total_dc_output
+71    grid_voltage: sensor.solis_inverter_a_phase_voltage
+72    battery_current_direction: sensor.solis_inverter_battery_current_direction
+73    inverter_status_59: sensor.solis_inverter_current_status
+74    remaining_solar: sensor.solcast_pv_forecast_forecast_remaining_today
+
+
+
+
+

Example 3 (Solis S6 or S2-WL-ST) - Integration via https://github.com/fboundy/ha_solis_modbus

+
 1  type: custom:sunsynk-power-flow-card
+ 2  cardstyle: full
+ 3  show_solar: true
+ 4  inverter:
+ 5    model: solis
+ 6  battery:
+ 7    energy: 54
+ 8    shutdown_soc: 20
+ 9    show_daily: true
+10  solar:
+11    show_daily: true
+12    mppts: 2
+13  load:
+14    show_daily: true
+15  grid:
+16    show_daily_buy: true
+17    show_daily_sell: false
+18    show_nonessential: false
+19  entities:
+20    inverter_voltage_154: sensor.solis_inverter_voltage
+21    load_frequency_192: sensor.solis_inverter_frequency
+22    inverter_current_164: sensor.solis_inverter_current
+23    inverter_power_175: sensor.solis_inverter_ac_power
+24    grid_connected_status_194: null
+25    grid_voltage: sensor.solis_grid_voltage
+26    inverter_status_59: sensor.solis_inverter_status
+27    day_battery_charge_70: none
+28    day_battery_discharge_71: none
+29    battery_voltage_183: sensor.solis_battery_voltage
+30    battery_soc_184: sensor.solis_battery_soc_lead
+31    battery_power_190: sensor.solis_battery_power
+32    battery_current_191: sensor.solis_battery_current
+33    battery_current_direction: sensor.solis_battery_current_direction
+34    grid_power_169: sensor.solis_grid_active_power_negative
+35    day_grid_import_76: sensor.solis_daily_energy_imported
+36    day_grid_export_77: sensor.solis_daily_energy_exported
+37    grid_ct_power_172: sensor.solis_grid_active_power_negative
+38    day_load_energy_84: sensor.solis_daily_consumption
+39    essential_power: sensor.solis_backup_load_power
+40    nonessential_power: none
+41    aux_power_166: none
+42    day_pv_energy_108: none
+43    pv1_power_186: none
+44    pv2_power_187: none
+45    pv1_voltage_109: sensor.solis_pv1_voltage
+46    pv1_current_110: sensor.solis_pv1_current
+47    pv2_voltage_111: sensor.solis_pv2_voltage
+48    pv2_current_112: sensor.solis_pv2_current
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/examples/sunsynk.html b/examples/sunsynk.html new file mode 100644 index 00000000..1d2f3f57 --- /dev/null +++ b/examples/sunsynk.html @@ -0,0 +1,489 @@ + + + + + + + Sunsynk Inverter — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Sunsynk Inverter

+
+

Minimum Configuration (No Solar, No Battery)

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: full
+ 3show_solar: false
+ 4show_battery: false
+ 5entities:
+ 6  inverter_power_175: sensor.sunsynk_inverter_power
+ 7  grid_power_169: sensor.sunsynk_grid_power
+ 8  battery_soc_184: sensor.sunsynk_battery_soc
+ 9  battery_power_190: sensor.sunsynk_battery_power
+10  battery_current_191: sensor.sunsynk_battery_current
+11  grid_ct_power_172: sensor.sunsynk_grid_ct_power
+
+
+
+
+

Minimum Configuration (Solar)

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: full
+ 3solar:
+ 4  mppts: 1
+ 5battery:
+ 6  energy: 15960
+ 7  shutdown_soc: 20
+ 8entities:
+ 9  inverter_power_175: sensor.sunsynk_inverter_power
+10  grid_power_169: sensor.sunsynk_grid_power
+11  battery_soc_184: sensor.sunsynk_battery_soc
+12  battery_power_190: sensor.sunsynk_battery_power
+13  battery_current_191: sensor.sunsynk_battery_current
+14  grid_ct_power_172: sensor.sunsynk_grid_ct_power
+15  pv1_power_186: sensor.sunsynk_pv1_power
+
+
+
+
+

Minimal Configuration (No Solar)

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: full
+ 3show_solar: false
+ 4battery:
+ 5  energy: 15960
+ 6  shutdown_soc: 20
+ 7entities:
+ 8  inverter_voltage_154: sensor.sunsynk_inverter_voltage
+ 9  load_frequency_192: sensor.sunsynk_load_frequency
+10  inverter_current_164: sensor.sunsynk_inverter_current
+11  inverter_power_175: sensor.sunsynk_inverter_power
+12  grid_power_169: sensor.sunsynk_grid_power
+13  battery_voltage_183: sensor.sunsynk_battery_voltage
+14  battery_soc_184: sensor.sunsynk_battery_soc
+15  battery_power_190: sensor.sunsynk_battery_power
+16  battery_current_191: sensor.sunsynk_battery_current
+17  grid_ct_power_172: sensor.sunsynk_grid_ct_power
+18  grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status
+19  inverter_status_59: sensor.overall_state
+
+
+
+
+

Minimal Configuration (No Battery)

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: full
+ 3show_battery: false
+ 4entities:
+ 5  inverter_voltage_154: sensor.sunsynk_inverter_voltage
+ 6  load_frequency_192: sensor.sunsynk_load_frequency
+ 7  inverter_current_164: sensor.sunsynk_inverter_current
+ 8  inverter_power_175: sensor.sunsynk_inverter_power
+ 9  grid_power_169: sensor.sunsynk_grid_power
+10  battery_voltage_183: sensor.sunsynk_battery_voltage
+11  battery_soc_184: sensor.sunsynk_battery_soc
+12  battery_power_190: sensor.sunsynk_battery_power
+13  battery_current_191: sensor.sunsynk_battery_current
+14  grid_ct_power_172: sensor.sunsynk_grid_ct_power
+15  grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status
+16  inverter_status_59: sensor.overall_state
+
+
+
+
+

Minimal Configuration (Solar and Battery)

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: full
+ 3solar:
+ 4  mppts: 2
+ 5battery:
+ 6  energy: 15960
+ 7  shutdown_soc: 20
+ 8load:
+ 9  show_aux: false
+10entities:
+11  inverter_voltage_154: sensor.sunsynk_inverter_voltage
+12  load_frequency_192: sensor.sunsynk_load_frequency
+13  inverter_current_164: sensor.sunsynk_inverter_current
+14  inverter_power_175: sensor.sunsynk_inverter_power
+15  grid_power_169: sensor.sunsynk_grid_power
+16  battery_voltage_183: sensor.sunsynk_battery_voltage
+17  battery_soc_184: sensor.sunsynk_battery_soc
+18  battery_power_190: sensor.sunsynk_battery_power
+19  battery_current_191: sensor.sunsynk_battery_current
+20  grid_ct_power_172: sensor.sunsynk_grid_ct_power
+21  grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status
+22  inverter_status_59: sensor.sunsynk_overall_state
+23  pv1_power_186: sensor.sunsynk_pv1_power
+24  pv2_power_187: sensor.sunsynk_pv2_power
+25  pv1_voltage_109: sensor.sunsynk_pv1_voltage
+26  pv1_current_110: sensor.sunsynk_pv1_current
+27  pv2_voltage_111: sensor.sunsynk_pv2_voltage
+28  pv2_current_112: sensor.sunsynk_pv2_current
+
+
+
+
+

Minimal Configuration (Solar + Daily Totals)

+
 1type: custom:sunsynk-power-flow-card
+ 2cardstyle: full
+ 3solar:
+ 4  mppts: 2
+ 5  show_daily: true
+ 6battery:
+ 7  energy: 15960
+ 8  shutdown_soc: 20
+ 9  show_daily: true
+10load:
+11  show_daily: true
+12grid:
+13  show_daily_buy: true
+14entities:
+15  inverter_voltage_154: sensor.sunsynk_inverter_voltage
+16  load_frequency_192: sensor.sunsynk_load_frequency
+17  inverter_current_164: sensor.sunsynk_inverter_current
+18  inverter_power_175: sensor.sunsynk_inverter_power
+19  grid_power_169: sensor.sunsynk_grid_power
+20  battery_voltage_183: sensor.sunsynk_battery_voltage
+21  battery_soc_184: sensor.sunsynk_battery_soc
+22  battery_power_190: sensor.sunsynk_battery_power
+23  battery_current_191: sensor.sunsynk_battery_current
+24  grid_ct_power_172: sensor.sunsynk_grid_ct_power
+25  grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status
+26  inverter_status_59: sensor.sunsynk_overall_state
+27  pv1_power_186: sensor.sunsynk_pv1_power
+28  pv2_power_187: sensor.sunsynk_pv2_power
+29  pv1_voltage_109: sensor.sunsynk_pv1_voltage
+30  pv1_current_110: sensor.sunsynk_pv1_current
+31  pv2_voltage_111: sensor.sunsynk_pv2_voltage
+32  pv2_current_112: sensor.sunsynk_pv2_current
+33  day_pv_energy_108: sensor.sunsynk_day_pv_energy
+34  day_battery_charge_70: sensor.sunsynk_day_battery_charge
+35  day_battery_discharge_71: sensor.sunsynk_day_battery_discharge
+36  day_load_energy_84: sensor.sunsynk_day_load_energy
+37  day_grid_import_76: sensor.sunsynk_day_grid_import
+
+
+
+
+

Full Configuration (All Options)

+
  1type: custom:sunsynk-power-flow-card
+  2cardstyle: full
+  3panel_mode: false
+  4large_font: false
+  5title: Sunsynk Inverter
+  6title_colour: grey
+  7title_size: 32px
+  8show_solar: true
+  9show_battery: true
+ 10show_grid: true
+ 11decimal_places: 2
+ 12dynamic_line_width: true
+ 13min_line_width: 1
+ 14max_line_width: 4
+ 15inverter:
+ 16  modern: true
+ 17  colour: grey
+ 18  autarky: 'power'
+ 19  auto_scale: true
+ 20  three_phase: false
+ 21battery:
+ 22  energy: 15960
+ 23  shutdown_soc: 20
+ 24  invert_power: false
+ 25  colour: pink
+ 26  show_daily: true
+ 27  animation_speed: 6
+ 28  max_power: 4500
+ 29  show_absolute: false
+ 30  auto_scale: true
+ 31  hide_soc: false
+ 32  dynamic_colour: true
+ 33  linear_gradient: true
+ 34solar:
+ 35  colour: orange
+ 36  show_daily: true
+ 37  mppts: 2
+ 38  animation_speed: 9
+ 39  max_power: 8000
+ 40  pv1_name: North
+ 41  pv2_name: North
+ 42  pv3_name: East
+ 43  pv4_name: West
+ 44  auto_scale: true
+ 45  display_mode: 1
+ 46  dynamic_colour: true
+ 47load:
+ 48  colour: '#5fb6ad'
+ 49  show_daily: true
+ 50  show_daily_aux: true
+ 51  show_aux: true
+ 52  invert_aux: false
+ 53  show_absolute_aux: false
+ 54  aux_name: Generator
+ 55  aux_type: gen
+ 56  aux_colour: green
+ 57  aux_off_colour: red
+ 58  aux_loads: 2
+ 59  aux_load1_name: Aux load 1
+ 60  aux_load2_name: Aux load 2
+ 61  aux_load1_icon: mdi:air-filter
+ 62  aux_load2_icon: mdi:stove
+ 63  animation_speed: 8
+ 64  max_power: 8000
+ 65  additional_loads: 2
+ 66  load1_name: Geyser
+ 67  load2_name: Pool
+ 68  load1_icon: boiler
+ 69  load2_icon: mdi:pool
+ 70  auto_scale: true
+ 71  dynamic_colour: true
+ 72grid:
+ 73  colour: '#5490c2'
+ 74  export_colour: brown
+ 75  grid_off_colour: red
+ 76  show_daily_buy: true
+ 77  show_daily_sell: true
+ 78  no_grid_colour: '#a40013'
+ 79  show_nonessential: true
+ 80  invert_grid: false
+ 81  nonessential_name: Non Essential
+ 82  nonessential_icon: oven
+ 83  additional_loads: 2
+ 84  load1_name: Load 1
+ 85  load2_name: Load 2
+ 86  load1_icon: boiler
+ 87  load2_icon: mdi:ev-station
+ 88  animation_speed: 8
+ 89  max_power: 8000
+ 90  auto_scale: true
+ 91entities:
+ 92  use_timer_248: switch.sunsynk_toggle_system_timer
+ 93  priority_load_243: switch.sunsynk_toggle_priority_load
+ 94  day_battery_charge_70: sensor.sunsynk_day_battery_charge
+ 95  day_battery_discharge_71: sensor.sunsynk_day_battery_discharge
+ 96  day_load_energy_84: sensor.sunsynk_day_load_energy
+ 97  day_grid_import_76: sensor.sunsynk_day_grid_import
+ 98  day_grid_export_77: sensor.sunsynk_day_grid_export
+ 99  day_pv_energy_108: sensor.sunsynk_day_pv_energy
+100  day_aux_energy: sensor.sunsynk_day_aux_energy
+101  inverter_voltage_154: sensor.sunsynk_inverter_voltage
+102  inverter_voltage_L2: null
+103  inverter_voltage_L3: null
+104  load_frequency_192: sensor.sunsynk_load_frequency
+105  inverter_current_164: sensor.sunsynk_inverter_current
+106  inverter_current_L2: null
+107  inverter_current_L3: null
+108  inverter_power_175: sensor.sunsynk_inverter_power
+109  grid_power_169: sensor.sunsynk_grid_power
+110  pv1_power_186: sensor.sunsynk_pv1_power
+111  pv2_power_187: sensor.sunsynk_pv2_power
+112  pv3_power_188: none
+113  pv4_power_189: none
+114  pv_total: sensor.sunsynk_totalsolar
+115  pv1_voltage_109: sensor.sunsynk_pv1_voltage
+116  pv1_current_110: sensor.sunsynk_pv1_current
+117  pv2_voltage_111: sensor.sunsynk_pv2_voltage
+118  pv2_current_112: sensor.sunsynk_pv2_current
+119  pv3_voltage_113: none
+120  pv3_current_114: none
+121  pv4_voltage_115: none
+122  pv4_current_116: none
+123  battery_voltage_183: sensor.sunsynk_battery_voltage
+124  battery_soc_184: sensor.sunsynk_battery_soc
+125  battery_power_190: sensor.sunsynk_battery_power
+126  battery_current_191: sensor.sunsynk_battery_current
+127  essential_power: none
+128  essential_load1: sensor.tuya_geyser_current_consumption
+129  essential_load2: sensor.load2_power
+130  essential_load1_extra: sensor.daily_geyser_energy
+131  essential_load2_extra: sensor.load2_extra
+132  nonessential_power: none
+133  non_essential_load1: sensor.nonessential1_power
+134  non_essential_load2: sensor.nonessential2_power
+135  grid_ct_power_172: sensor.sunsynk_grid_ct_power
+136  grid_ct_power_L2: null
+137  grid_ct_power_L3: null
+138  grid_connected_status_194: binary_sensor.sunsynk_grid_connected_status
+139  inverter_status_59: sensor.sunsynk_overall_state
+140  aux_power_166: sensor.sunsynk_aux_power
+141  aux_connected_status: binary_sensor.sunsynk_aux_connected_status
+142  remaining_solar: sensor.solcast_forecast_remaining_today
+143  battery_temp_182: sensor.sunsynk_battery_temperature
+144  radiator_temp_91: sensor.sunsynk_radiator_temperature
+145  dc_transformer_temp_90: sensor.sunsynk_dc_transformer_temperature
+146  environment_temp: sensor.home_realfeel_temperature
+147  prog1_time: sensor.sunsynk_time_slot_1
+148  prog1_capacity: number.sunsynk_prog1_capacity
+149  prog1_charge: switch.sunsynk_prog1_grid_charge
+150  prog2_time: sensor.sunsynk_time_slot_2
+151  prog2_capacity: number.sunsynk_prog2_capacity
+152  prog2_charge: switch.sunsynk_prog2_grid_charge
+153  prog3_time: sensor.sunsynk_time_slot_3
+154  prog3_capacity: number.sunsynk_prog3_capacity
+155  prog3_charge: switch.sunsynk_prog3_grid_charge
+156  prog4_time: sensor.sunsynk_time_slot_4
+157  prog4_capacity: number.sunsynk_prog4_capacity
+158  prog4_charge: switch.sunsynk_prog4_grid_charge
+159  prog5_time: sensor.sunsynk_time_slot_5
+160  prog5_capacity: number.sunsynk_prog5_capacity
+161  prog5_charge: switch.sunsynk_prog5_grid_charge
+162  prog6_time: sensor.sunsynk_time_slot_6
+163  prog6_capacity: number.sunsynk_prog6_capacity
+164  prog6_charge: switch.sunsynk_prog6_grid_charge
+165  energy_cost_buy: sensor.tibber_energy_cost_buy
+166  energy_cost_sell: sensor.tibber_energy_cost_sell
+167  solar_sell_247: switch.sunsynk_toggle_solar_sell
+168  aux_load1: sensor.gesyer
+169  aux_load2: sensor.pool_pump
+170  aux_load1_extra: sensor.daily_geyser_energy
+171  aux_load2_extra: sensor.pool_temperature
+172  load_power_L1: null
+173  load_power_L2: null
+174  load_power_L3: null
+175  total_pv_generation: null
+176  battery_status: null
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/examples/victron.html b/examples/victron.html new file mode 100644 index 00000000..fe9eb12f --- /dev/null +++ b/examples/victron.html @@ -0,0 +1,315 @@ + + + + + + + Victron Inverters — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Victron Inverters

+
+

Note

+

PAGE UNDER DEVELOPMENT

+
+
+

Example 1 - Victron <MODEL> with Battery / Solar / No Grid

+

Integration via https://github.com/nathanmarlor/foxess_modbus

+
1
+
+
+
  1type: custom:sunsynk-power-flow-card
+  2cardstyle: full
+  3panel_mode: false
+  4large_font: false
+  5title: Victron - Power Monitor
+  6title_colour: White
+  7title_size: 18px
+  8show_solar: true
+  9show_grid: true
+ 10show_battery: true
+ 11decimal_places: 2
+ 12dynamic_line_width: true
+ 13inverter:
+ 14  modern: false
+ 15  colour: grey
+ 16  autarky: power
+ 17  auto_scale: true
+ 18  model: huawei
+ 19  three_phase: false
+ 20battery:
+ 21  energy: 14850
+ 22  shutdown_soc: sensor.battery_end_of_discharge_soc
+ 23  invert_power: true
+ 24  colour: '#fc8d83'
+ 25  show_daily: true
+ 26  animation_speed: 5
+ 27  max_power: 5000
+ 28  show_absolute: true
+ 29  auto_scale: true
+ 30  hide_soc: false
+ 31  show_remaining_energy: true
+ 32  dynamic_colour: true
+ 33  linear_gradient: true
+ 34solar:
+ 35  colour: '#F7BC00'
+ 36  show_daily: true
+ 37  mppts: 2
+ 38  animation_speed: 8
+ 39  max_power: 6600
+ 40  pv1_name: Inv1.S1
+ 41  pv2_name: Inv2.S1
+ 42  display_mode: 2
+ 43  auto_scale: true
+ 44load:
+ 45  colour: magenta
+ 46  show_daily: true
+ 47  show_daily_aux: true
+ 48  show_aux: true
+ 49  invert_aux: false
+ 50  show_absolute_aux: false
+ 51  aux_name: Generator
+ 52  aux_type: gen
+ 53  aux_colour: '#5490c2'
+ 54  aux_off_colour: brown
+ 55  aux_loads: 2
+ 56  aux_load1_name: IT - Servers
+ 57  aux_load2_name: IT - Network
+ 58  aux_load1_icon: mdi:server-network
+ 59  aux_load2_icon: mdi:network
+ 60  animation_speed: 4
+ 61  essential_name: Essential
+ 62  max_power: 4000
+ 63  additional_loads: 2
+ 64  load1_name: Lights
+ 65  load2_name: All GPO
+ 66  load3_name: Spare
+ 67  load4_name: Spare
+ 68  load1_icon: mdi:lightbulb
+ 69  load2_icon: mdi:power-plug
+ 70  load3_icon: mdi:water-boiler
+ 71  load4_icon: mdi:kettle
+ 72  auto_scale: true
+ 73  dynamic_icon: true
+ 74  dynamic_colour: true
+ 75grid:
+ 76  grid_name: Your-Grid-Name
+ 77  colour: '#FF2400'
+ 78  export_colour: green
+ 79  no_grid_colour: '#a40013'
+ 80  grid_off_colour: '#e7d59f'
+ 81  show_daily_buy: true
+ 82  show_daily_sell: true
+ 83  show_nonessential: true
+ 84  invert_grid: true
+ 85  nonessential_name: Non Essential
+ 86  nonessential_icon: none
+ 87  additional_loads: 2
+ 88  load1_name: HVAC
+ 89  load2_name: EV
+ 90  load1_icon: mdi:fan
+ 91  load2_icon: mdi:car
+ 92  animation_speed: 7
+ 93  max_power: 15000
+ 94  auto_scale: true
+ 95  dynamic_icon: true
+ 96  dynamic_colour: true
+ 97  energy_cost_decimals: 3
+ 98entities:
+ 99  use_timer_248: null
+100  priority_load_243: null
+101  day_battery_charge_70: sensor.batteries_day_charge
+102  day_battery_discharge_71: sensor.batteries_day_discharge
+103  day_load_energy_84: sensor.house_consumption_energy_daily
+104  day_grid_import_76: sensor.hs_grid_imported_daily
+105  day_grid_export_77: sensor.hs_grid_exported_daily
+106  day_pv_energy_108: sensor.inverters_daily_yield
+107  day_aux_energy: sensor.sunsynk_card_aux_energy_daily
+108  inverter_voltage_154: sensor.power_meter_voltage
+109  load_frequency_192: sensor.power_meter_frequency
+110  grid_power_169: sensor.house_consumption_power
+111  inverter_current_164: sensor.inverter_phase_a_current
+112  inverter_power_175: sensor.inverters_active_power
+113  inverter_status_59: sensor.inverters_state
+114  radiator_temp_91: null
+115  dc_transformer_temp_90: sensor.inverters_internal_temperature
+116  pv1_power_186: sensor.inverter_1_pv_1_power
+117  pv2_power_187: sensor.inverter_1_pv_2_power
+118  environment_temp: sensor.<your_location>_temp
+119  remaining_solar: sensor.energy_production_today_remaining
+120  pv1_voltage_109: sensor.inverter_pv_1_voltage
+121  pv1_current_110: sensor.inverter_pv_1_current
+122  pv2_voltage_111: sensor.inverter_pv_2_voltage
+123  pv2_current_112: sensor.inverter_pv_2_current
+124  battery_voltage_183: sensor.batteries_bus_voltage
+125  battery_soc_184: sensor.batteries_state_of_capacity
+126  battery_power_190: sensor.batteries_charge_discharge_power
+127  battery_current_191: sensor.batteries_bus_current
+128  battery_temp_182: sensor.batteries_temperature
+129  battery_status: sensor.batteries_status
+130  essential_power: sensor.house_consumption_power_less_aux_non_essential
+131  essential_load1: sensor.lights_all_active_power
+132  essential_load2: sensor.gpo_all_active_power_less_known
+133  essential_load1_extra: null
+134  essential_load2_extra: null
+135  nonessential_power: sensor.sunsynk_card_non_essential_active_power
+136  non_essential_load1: sensor.hvac_active_power
+137  non_essential_load2: sensor.ev_charger_active_power
+138  grid_ct_power_172: sensor.power_meter_active_power
+139  grid_ct_power_total: sensor.power_meter_active_power
+140  grid_connected_status_194: sensor.inverters_off_grid_status
+141  aux_power_166: sensor.sunsynk_card_aux_active_power
+142  aux_connected_status: binary_sensor.sunsynk_card_aux_connected_status
+143  energy_cost_buy: sensor.electricity_price
+144  energy_cost_sell: sensor.electricity_fit
+145  solar_sell_247: switch.null
+146  aux_load1: sensor.it_hardware_network_active_power
+147  aux_load2: sensor.it_hardware_servers_active_power
+148  aux_load1_extra: sensor.env_network_rack_bme280_temperature
+149  aux_load2_extra: sensor.garage_controller_bme280_temperature
+150  grid_voltage: sensor.power_meter_voltage
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 00000000..e9adb5c4 --- /dev/null +++ b/genindex.html @@ -0,0 +1,148 @@ + + + + + + Index — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Index
    • +
  • +
    • +
+
+
+
+
+ + +

Index

+ +
+ +
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..62f99b54 --- /dev/null +++ b/index.html @@ -0,0 +1,245 @@ + + + + + + + Sunsynk-Power-Flow-Card — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Sunsynk-Power-Flow-Card

+

An animated Home Assistant card to emulate the power flow that’s shown on the Sunsynk Inverter screen. You can use this to display data from many inverters e.g. Sunsynk, Deye, Solis, Lux, FoxESS, Goodwe, Huawei etc as long as you have the required sensor data. See the wiki for integration methods and examples.

+

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store. +GitHub release (latest by date) Buy Me A Coffee

+
+

Documentation

+

Refer to https://slipx06.github.io/sunsynk-power-flow-card/index.html

+
+
+

Features

+
    +

  • Option to switch between three card styles: compact, lite or full.

    • +

  • Animated power flow based on positive/negative/zero sensor values with configurable dynamic speed. (Supports inverted battery, AUX and grid power).

    • +

  • Dynamic battery image based on SOC.

    • +

  • Grid connected status.

    • +

  • Configurable battery size and shutdown SOC to calculate and display remaining battery runtime based on current battery usage and system time slot setting i.e. SOC, Grid Charge. Can be toggled off.

    • +

  • Daily Totals that can be toggled on or off.

    • +

  • Hide all solar data if not installed or specify number of mppts in use. Set custom MPPT labels.

    • +

  • “Use Timer” setting and “Energy Pattern” setting (Priority Load or Priority Battery) shown as dynamic icons, with the ability to hide if not required. If setup as switches can be toggled by clicking on the card.

    • +

  • Panel mode for bigger card.

    • +

  • AUX and Non-essential can be hidden from the full card or assigned configurable labels.

    • +

  • Customisable - Change colours and images.

    • +

  • Most entities can be clicked to show more-info dialog.

    • +

  • Optional data points include self sufficiency and ratio percentages, battery temperature, AC and DC temperature.

    • +

  • Display additional non-essential, essential and AUX loads.

    • +

  • Display energy cost per kWh and solar sell status.

    • +

  • Select your inverter model for custom inverter status and battery status messages i.e. Sunsynk, Lux, Goodwe, Solis.

    • +
+
+
+

Screenshots

+

Compact Version

+

image +image

+

Lite Version

+

image +image +image +image

+

Full Version

+

image +image

+
+
+

Installation

+

The card can be installed via HACS (recommended) or manually.

+
+

Installation using HACS

+

hacs_badge

+
    +

  1. Install HACS.

    2. +

  2. Search & Install sunsynk-power-flow-card or click the button below.

    3. +
+

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

+
+
+

Manual Installation

+
    +

  1. Create a new directory under www and name it sunsynk-power-flow-card e.g www/sunsynk-power-flow-card/.

    2. +

  2. Copy the sunsynk-power-flow-card.js into the directory.

    3. +

  3. Add the resource to your Dashboard. You can append the filename with a ?ver=x and increment x each time you download a new version to force a reload and avoid using a cached version. It is also a good idea to clear your browser cache.

    4. +
+

image

+
+
+
+
+

Table of Contents

+
+

Configuration

+ +
+
+

Examples

+ +
+
+

Contribute

+ +
+
+ + +
+
+ +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 00000000..b367a8ef Binary files /dev/null and b/objects.inv differ diff --git a/search.html b/search.html new file mode 100644 index 00000000..82255a12 --- /dev/null +++ b/search.html @@ -0,0 +1,163 @@ + + + + + + Search — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 00000000..32e54099 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["configuration", "contribute/bugs", "contribute/devcontainer", "contribute/devcycle", "contribute/docs", "examples/foxess", "examples/goodwe", "examples/huawei", "examples/lux", "examples/solax", "examples/solis", "examples/sunsynk", "examples/victron", "index", "toc"], "filenames": ["configuration.md", "contribute/bugs.rst", "contribute/devcontainer.rst", "contribute/devcycle.rst", "contribute/docs.rst", "examples/foxess.rst", "examples/goodwe.rst", "examples/huawei.rst", "examples/lux.rst", "examples/solax.rst", "examples/solis.rst", "examples/sunsynk.rst", "examples/victron.rst", "index.rst", "toc.rst"], "titles": ["Configuration", "Reporting Bugs", "VS Code - DevContainer", "Development Cycle", "Documentation", "FoxESS Inverter", "Goodwe Inverter", "Huawei Inverter", "Lux Inverter", "SolaX Inverter", "Solis Inverter", "Sunsynk Inverter", "Victron Inverters", "Sunsynk-Power-Flow-Card", "<no title>"], "terms": {"The": [0, 2, 3, 4, 6, 13], "card": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "can": [0, 1, 3, 4, 6, 7, 13], "through": [0, 1], "follow": [0, 1, 3, 7], "attribut": 0, "requir": [0, 3, 13], "default": [0, 3, 7], "descript": [0, 1], "type": [0, 5, 6, 7, 8, 9, 10, 11, 12], "custom": [0, 5, 6, 7, 8, 9, 10, 11, 12, 13], "sunsynk": [0, 1, 3, 5, 6, 7, 8, 9, 10, 12, 14], "power": [0, 1, 3, 5, 6, 8, 9, 10, 11, 12], "flow": [0, 1, 3, 5, 6, 7, 8, 9, 10, 11, 12], "cardstyl": [0, 5, 6, 7, 8, 9, 10, 11, 12], "lite": [0, 6, 8, 10, 13], "select": [0, 2, 7, 13], "layout": 0, "i": [0, 2, 3, 4, 6, 7, 13], "us": [0, 1, 2, 3, 4, 6, 7], "compact": [0, 9, 13], "full": [0, 5, 7, 10, 12, 13], "panel_mod": [0, 5, 6, 7, 9, 10, 11, 12], "option": [0, 7, 13], "fals": [0, 5, 6, 7, 8, 9, 10, 11, 12], "toggl": [0, 13], "panel": [0, 13], "mode": [0, 13], "set": [0, 3, 7, 13], "height": 0, "100": [0, 3, 6], "For": [0, 1], "1": [0, 11], "view": [0, 7], "large_font": [0, 6, 7, 9, 10, 11, 12], "increas": 0, "font": 0, "size": [0, 13], "sensor": [0, 5, 6, 8, 9, 10, 11, 12, 13], "data": [0, 7, 13], "titl": [0, 1, 6, 7, 11, 12], "e": [0, 1, 6, 13], "One": 0, "title_colour": [0, 6, 11, 12], "colour": [0, 5, 6, 7, 10, 11, 12, 13], "red": [0, 10, 11], "green": [0, 6, 7, 11, 12], "blue": 0, "etc": [0, 13], "title_s": [0, 6, 7, 11, 12], "32px": [0, 6, 11], "16px": 0, "24px": 0, "show_solar": [0, 5, 6, 7, 8, 9, 10, 11, 12], "true": [0, 5, 6, 7, 8, 9, 10, 11, 12], "displai": [0, 13], "inform": [0, 1], "show_batteri": [0, 6, 7, 9, 11, 12], "show_grid": [0, 6, 7, 9, 11, 12], "card_height": [0, 10], "396px": 0, "onli": 0, "when": [0, 1, 2, 7], "pixel": 0, "specifi": [0, 13], "valu": [0, 3, 13], "400px": 0, "provid": [0, 1, 3, 6, 7], "input": [0, 7], "numer_height": 0, "card_width": [0, 5], "width": 0, "percentag": [0, 13], "80": [0, 5], "adjust": 0, "decimal_plac": [0, 7, 11, 12], "2": [0, 5, 6, 9, 11, 12], "number": [0, 3, 6, 8, 11, 13], "decim": 0, "place": 0, "auto_scal": [0, 5, 6, 7, 9, 11, 12], "dynamic_line_width": [0, 7, 11, 12], "line": 0, "anim": [0, 1, 13], "dot": 0, "base": [0, 7, 13], "ratio": [0, 13], "current": [0, 7, 13], "max_pow": [0, 5, 6, 7, 9, 10, 11, 12], "defin": 0, "each": [0, 3, 4, 7, 13], "section": [0, 1, 7], "below": [0, 1, 3, 6, 7, 13], "explicitli": 0, "max_line_width": [0, 11], "4": [0, 11, 12], "maximum": 0, "If": [0, 1, 2, 13], "you": [0, 1, 2, 3, 4, 7, 13], "prefer": 0, "thick": 0, "larger": 0, "reduc": 0, "thi": [0, 1, 2, 3, 4, 7, 13], "more": [0, 1, 13], "subtl": 0, "scale": 0, "affect": 0, "greater": 0, "8": [0, 7, 10, 11, 12], "ar": [0, 1, 2, 3, 4, 7], "ignor": 0, "min_line_width": [0, 11], "minimum": [0, 7], "see": [0, 1, 2, 3, 6, 13], "list": [0, 1, 7], "modern": [0, 5, 6, 7, 9, 10, 11, 12], "imag": [0, 13], "an": [0, 1, 3, 4, 7, 13], "model": [0, 5, 6, 7, 8, 9, 10, 13], "grei": [0, 6, 7, 11, 12], "hex": 0, "code": [0, 1, 3, 7, 13, 14], "66ff00": 0, "name": [0, 3, 6, 7, 12, 13], "autarki": [0, 5, 6, 7, 10, 11, 12], "either": 0, "realtim": 0, "daili": [0, 7, 13], "energi": [0, 5, 6, 7, 8, 9, 10, 11, 12, 13], "hide": [0, 13], "self": [0, 13], "suffici": [0, 13], "home": [0, 7, 13], "product": 0, "produc": 0, "electr": [0, 7], "It": [0, 13], "calcul": [0, 13], "formula": 0, "borrow": 0, "from": [0, 1, 2, 3, 7, 13], "distribut": [0, 3], "percent": 0, "consumpt": [0, 7], "which": [0, 1], "statu": [0, 13], "lux": [0, 13, 14], "soli": [0, 13, 14], "goodw": [0, 13, 14], "goodwe_gridmod": [0, 6], "foxess": [0, 13, 14], "solax": [0, 13, 14], "victron": [0, 13, 14], "froniu": 0, "solaredg": 0, "growatt": 0, "sofar": 0, "ce": 0, "box": 0, "dey": [0, 13], "azzurro": 0, "powmr": 0, "huawei": [0, 12, 13, 14], "unit_of_measur": [0, 6], "perform": [0, 1], "correct": [0, 4], "than": 0, "999w": 0, "kw": 0, "g": [0, 1, 13], "23kw": 0, "unit": [0, 7], "chang": [0, 1, 2, 7, 13], "apart": 0, "round": 0, "three_phas": [0, 6, 7, 11, 12], "addit": [0, 1, 3, 7, 13], "3": [0, 5, 6, 12], "phase": [0, 7], "inverter_current_l2": [0, 6, 7, 11], "inverter_current_l3": [0, 6, 7, 11], "inverter_voltage_l2": [0, 6, 7, 11], "inverter_voltage_l3": [0, 6, 7, 11], "grid_ct_power_l2": [0, 6, 7, 11], "grid_ct_power_l3": [0, 6, 7, 11], "load_power_l1": [0, 6, 7, 11], "load_power_l2": [0, 6, 7, 11], "load_power_l3": [0, 6, 7, 11], "To": [0, 4, 7], "absolut": 0, "show_absolut": [0, 6, 7, 9, 11, 12], "return": 0, "your": [0, 1, 2, 3, 6, 7, 8, 12, 13], "direct": 0, "depend": [0, 6], "charg": [0, 7, 13], "discharg": [0, 6, 7], "state": [0, 6, 7], "invert_pow": [0, 6, 7, 8, 9, 11, 12], "revers": 0, "need": [0, 1, 7], "0": [0, 8], "total": [0, 7, 13], "wh": 0, "x": [0, 13], "5": [0, 12], "32kwh": 0, "15960": [0, 11], "remain": [0, 13], "runtim": [0, 13], "hidden": [0, 13], "numer": 0, "sunsynk_battery_energi": 0, "shutdown_soc": [0, 5, 6, 7, 8, 9, 10, 11, 12], "20": [0, 8, 10, 11], "shutdown": [0, 6, 13], "sunsynk_battery_capacity_shutdown": 0, "shutdown_soc_offgrid": 0, "appli": [0, 3], "offgrid": 0, "offgrid_battery_capacity_shutdown": 0, "posit": [0, 13], "neg": [0, 13], "pink": [0, 5, 10, 11], "all": [0, 2, 3, 7, 12, 13], "object": 0, "charge_colour": 0, "dynamic_colour": [0, 7, 9, 11, 12], "icon": [0, 6, 13], "contribut": 0, "sourc": [0, 7], "suppli": 0, "disabl": [0, 7], "priority_load_243": [0, 5, 7, 11, 12], "prioritis": 0, "essenti": [0, 7, 11, 12, 13], "ommit": 0, "linear_gradi": [0, 7, 11, 12], "block": [0, 1], "insid": [0, 2], "repres": 0, "soc": [0, 6, 13], "linear": 0, "gradient": 0, "rang": 0, "show_daili": [0, 5, 6, 7, 8, 9, 10, 11, 12], "animation_spe": [0, 6, 7, 9, 10, 11, 12], "6": [0, 9, 10, 11], "slowest": 0, "speed": [0, 13], "second": 0, "draw": 0, "4500": [0, 11], "battery_maximum_discharging_pow": 0, "hide_soc": [0, 7, 9, 11, 12], "program": 0, "capac": [0, 7], "shown": [0, 3, 7, 13], "left": 0, "show_remaining_energi": [0, 7, 12], "kwh": [0, 7, 13], "visabl": 0, "These": 0, "orang": [0, 11], "display_mod": [0, 6, 7, 9, 11, 12], "forecast": 0, "gener": [0, 7, 11, 12], "element": 0, "out": [0, 1], "10w": 0, "mppt": [0, 5, 6, 7, 8, 9, 10, 11, 12, 13], "": [0, 1, 13], "9": [0, 6, 9, 10, 11], "8000": [0, 11], "pv1_name": [0, 5, 6, 7, 8, 10, 11, 12], "pv1": [0, 8], "disapli": 0, "mppt1": 0, "pv2_name": [0, 5, 6, 7, 8, 10, 11, 12], "pv2": [0, 8], "mppt2": 0, "pv3_name": [0, 5, 7, 11], "pv3": 0, "mppt3": 0, "pv4_name": [0, 7, 11], "pv4": 0, "mppt4": 0, "5fb6ad": [0, 11], "setss": 0, "dynamic_icon": [0, 7, 12], "singl": [0, 7], "invert_load": 0, "show_daily_aux": [0, 7, 11, 12], "aux": [0, 7, 11, 13], "show_aux": [0, 5, 7, 9, 10, 11, 12], "invert_aux": [0, 7, 11, 12], "output": 0, "show_absolute_aux": [0, 7, 11, 12], "aux_nam": [0, 5, 7, 11, 12], "auxilari": 0, "aux_typ": [0, 7, 11, 12], "preset": 0, "ani": [0, 2, 3], "mdi": [0, 5, 6, 7, 9, 10, 11, 12], "ev": [0, 5, 7, 9, 11, 12], "station": [0, 5, 9, 11], "gen": [0, 7, 11, 12], "oven": [0, 11], "pump": [0, 5, 7], "aircon": 0, "boiler": [0, 5, 7, 11, 12], "aux_colour": [0, 7, 11, 12], "aux_dynamic_colour": 0, "respect": 0, "0w": 0, "aux_off_colour": [0, 7, 11, 12], "label": [0, 13], "disconnect": 0, "aux_load": [0, 5, 7, 11, 12], "side": 0, "aux_load1_nam": [0, 5, 7, 11, 12], "aux_load2_nam": [0, 5, 7, 11, 12], "aux_load1_icon": [0, 5, 7, 11, 12], "aux_load2_icon": [0, 5, 7, 11, 12], "essential_nam": [0, 5, 7, 12], "additional_load": [0, 5, 7, 8, 9, 10, 11, 12], "three": [0, 7, 13], "four": 0, "load1_nam": [0, 5, 7, 9, 10, 11, 12], "load2_nam": [0, 5, 7, 9, 10, 11, 12], "load3_nam": [0, 7, 12], "load4_nam": [0, 7, 12], "load1_icon": [0, 5, 7, 9, 10, 11, 12], "none": [0, 7, 8, 10, 11, 12], "load2_icon": [0, 5, 7, 9, 10, 11, 12], "load3_icon": [0, 7, 12], "avail": [0, 7], "show": [0, 1, 7, 8, 13], "load4_icon": [0, 7, 12], "5490c2": [0, 7, 11, 12], "grid_nam": [0, 7, 12], "export_colour": [0, 6, 7, 9, 11, 12], "export": [0, 7], "sell": [0, 13], "abov": [0, 3], "no_grid_colour": [0, 7, 9, 10, 11, 12], "grid_off_colour": [0, 7, 11, 12], "show_daily_bui": [0, 5, 7, 8, 9, 10, 11, 12], "bui": 0, "show_daily_sel": [0, 5, 7, 8, 9, 10, 11, 12], "show_nonessenti": [0, 5, 6, 7, 8, 9, 10, 11, 12], "non": [0, 7, 11, 12, 13], "nonessential_icon": [0, 5, 7, 11, 12], "nonessential_nam": [0, 5, 7, 11, 12], "third": 0, "timer": [0, 13], "schedul": 0, "due": 0, "limit": 0, "space": 0, "invert_grid": [0, 5, 6, 7, 8, 10, 11, 12], "import": 0, "energy_cost_decim": [0, 7, 12], "cost": [0, 7, 13], "have": [0, 3, 13], "been": [0, 1], "append": [0, 13], "modbu": 0, "regist": 0, "pv2_power_187": [0, 5, 6, 7, 8, 10, 11, 12], "indic": 0, "should": [0, 2, 3, 7], "read": 0, "replac": [0, 7, 8], "own": 0, "specif": [0, 1, 3], "expect": [0, 1, 3], "miss": 0, "day_pv_energy_108": [0, 5, 6, 7, 8, 9, 10, 11, 12], "placehold": 0, "zero": [0, 6, 13], "other": [0, 2], "solarday_108": 0, "wiki": [0, 7, 13], "map": 0, "integr": [0, 3, 6, 7, 12, 13], "method": [0, 13], "use_timer_248": [0, 5, 7, 10, 11, 12], "switch": [0, 7, 10, 11, 12, 13], "sunsynk_toggle_system_tim": [0, 10, 11], "next": [0, 4], "sunsynk_toggle_priority_load": [0, 11], "pattern": [0, 13], "prioriti": [0, 13], "day_battery_discharge_71": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_day_battery_discharg": [0, 11], "usag": [0, 7, 13], "day_battery_charge_70": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_day_battery_charg": [0, 11], "day_load_energy_84": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_day_load_energi": [0, 11], "day_grid_import_76": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_day_grid_import": [0, 11], "day_grid_export_77": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_day_grid_export": [0, 11], "sunsynk_day_pv_energi": [0, 11], "day_aux_energi": [0, 7, 11, 12], "inverter_voltage_154": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_inverter_voltag": [0, 11], "l1": 0, "voltag": [0, 7], "v": [0, 3, 13, 14], "l2": 0, "l3": 0, "load_frequency_192": [0, 6, 7, 8, 10, 11, 12], "sunsynk_load_frequ": [0, 11], "frequenc": [0, 7], "hz": 0, "inverter_current_164": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_inverter_curr": [0, 11], "A": [0, 3, 6, 7], "inverter_power_175": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_inverter_pow": [0, 11], "w": [0, 7], "essential_pow": [0, 5, 6, 7, 8, 10, 11, 12], "grid_power_169": [0, 5, 7, 8, 9, 10, 11, 12], "sunsynk_grid_pow": [0, 11], "note": [0, 3, 6], "167": 0, "ld": 0, "wrong": 0, "nonessential_pow": [0, 5, 7, 8, 10, 11, 12], "pv1_power_186": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_pv1_pow": [0, 11], "pv": 0, "string": 0, "sunsynk_pv2_pow": [0, 11], "pv3_power_188": [0, 5, 7, 11], "sunsynk_pv3_pow": 0, "pv4_power_189": [0, 7, 11], "sunsynk_pv4_pow": 0, "pv_total": [0, 6, 7, 8, 10, 11], "omit": 0, "intern": [0, 7], "logic": 0, "battery_voltage_183": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_battery_voltag": [0, 11], "battery_soc_184": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_battery_soc": [0, 11], "battery_power_190": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_battery_pow": [0, 11], "ye": 0, "report": [0, 7, 13, 14], "wai": [0, 2, 4], "around": 0, "battery_current_191": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_battery_curr": [0, 11], "battery_temp_182": [0, 6, 7, 9, 11, 12], "sunsynk_battery_temperatur": [0, 11], "temperatur": [0, 7, 13], "battery_rated_capac": 0, "rate": [0, 7], "ah": 0, "under": [0, 1, 4, 12, 13], "automat": 0, "overid": 0, "measur": [0, 7], "case": [0, 2], "assist": [0, 7, 13], "essential_load1": [0, 5, 7, 9, 10, 11, 12], "contain": [0, 2], "also": [0, 3, 13], "temp": 0, "essential_load2": [0, 5, 7, 9, 10, 11, 12], "essential_load3": 0, "essential_load4": 0, "essential_load1_extra": [0, 7, 9, 11, 12], "want": [0, 7], "essential_load2_extra": [0, 7, 9, 11, 12], "non_essential_load1": [0, 7, 11, 12], "non_essential_load2": [0, 7, 11, 12], "non_essential_load3": 0, "non_essential_load1_extra": 0, "nonessenti": 0, "non_essential_load2_extra": 0, "grid_ct_power_tot": [0, 6, 7, 12], "system": [0, 13], "ct": 0, "grid_ct_power_172": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_grid_ct_pow": [0, 11], "pv1_voltage_109": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_pv1_voltag": [0, 11], "pv1_current_110": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_pv1_curr": [0, 11], "pv2_voltage_111": [0, 5, 6, 7, 8, 10, 11, 12], "sunsynk_pv2_voltag": [0, 11], "pv2_current_112": [0, 5, 6, 7, 8, 10, 11, 12], "sunsynk_pv2_curr": [0, 11], "pv3_voltage_113": [0, 5, 7, 11], "sunsynk_pv3_voltag": 0, "pv3_current_114": [0, 5, 7, 11], "sunsynk_pv3_curr": 0, "pv4_voltage_115": [0, 7, 11], "sunsynk_pv4_voltag": 0, "pv4_current_116": [0, 7, 11], "sunsynk_pv4_curr": 0, "grid_connected_status_194": [0, 5, 6, 7, 10, 11, 12], "binary_sensor": [0, 7, 11, 12], "sunsynk_grid_connected_statu": [0, 11], "connect": [0, 13], "insensit": 0, "off": [0, 13], "On": 0, "inverter_status_59": [0, 5, 6, 7, 8, 9, 10, 11, 12], "sunsynk_overall_st": [0, 11], "standbi": 0, "selftest": 0, "normal": [0, 1], "alarm": 0, "fault": 0, "7": [0, 7, 12], "10": 0, "11": [0, 9], "12": 0, "16": 0, "17": 0, "32": 0, "40": 0, "64": 0, "136": 0, "192": 0, "57": 0, "wait": 0, "flash": 0, "check": [0, 1], "idl": 0, "battery_statu": [0, 6, 7, 11, 12], "battery_mode_cod": [0, 6], "aux_power_166": [0, 5, 7, 8, 10, 11, 12], "sunsynk_aux_pow": [0, 11], "aux_load1": [0, 5, 7, 11, 12], "aux_load2": [0, 5, 7, 11, 12], "aux_load1_extra": [0, 7, 11, 12], "aux_load2_extra": [0, 5, 7, 11, 12], "ssensor": 0, "aux_connected_statu": [0, 7, 11, 12], "remaining_solar": [0, 6, 7, 8, 9, 10, 11, 12], "solcast_forecast_remaining_todai": [0, 11], "dai": [0, 7], "total_pv_gener": [0, 6, 11], "lifetim": 0, "radiator_temp_91": [0, 6, 7, 8, 9, 10, 11, 12], "sunsynk_radiator_temperatur": [0, 11], "ac": [0, 5, 13], "environment_temp": [0, 7, 11, 12], "outsid": 0, "environ": [0, 2], "sun": 0, "dc_transformer_temp_90": [0, 6, 7, 8, 10, 11, 12], "sunsynk_dc_transformer_temperatur": [0, 11], "dc": [0, 13], "prog1_tim": [0, 11], "sunsynk_time_slot_1": [0, 11], "start": [0, 1, 2, 3], "time": [0, 7, 13], "hh": 0, "mm": 0, "prog1_capac": [0, 11], "sunsynk_system_mode_soc_time1": 0, "prog1_charg": [0, 11], "sunsynk_system_mode_grid_charge_time1": 0, "No": 0, "prog2_tim": [0, 11], "sunsynk_time_slot_2": [0, 11], "prog2_capac": [0, 11], "sunsynk_system_mode_soc_time2": 0, "prog2_charg": [0, 11], "sunsynk_system_mode_grid_charge_time2": 0, "prog3_tim": [0, 11], "sunsynk_time_slot_3": [0, 11], "prog3_capac": [0, 11], "sunsynk_system_mode_soc_time3": 0, "prog3_charg": [0, 11], "sunsynk_system_mode_grid_charge_time3": 0, "prog4_tim": [0, 11], "sunsynk_time_slot_4": [0, 11], "prog4_capac": [0, 11], "sunsynk_system_mode_soc_time4": 0, "prog4_charg": [0, 11], "sunsynk_system_mode_grid_charge_time4": 0, "prog5_tim": [0, 11], "sunsynk_time_slot_5": [0, 11], "prog5_capac": [0, 11], "sunsynk_system_mode_soc_time5": 0, "prog5_charg": [0, 11], "sunsynk_system_mode_grid_charge_time5": 0, "prog6_tim": [0, 11], "sunsynk_time_slot_6": [0, 11], "prog6_capac": [0, 11], "sunsynk_system_mode_soc_time6": 0, "prog6_charg": [0, 11], "sunsynk_system_mode_grid_charge_time6": 0, "energy_cost_bui": [0, 5, 6, 7, 10, 11, 12], "per": [0, 13], "energy_cost_sel": [0, 5, 6, 7, 10, 11, 12], "solar_sell_247": [0, 7, 11, 12], "sunsynk_toggle_solar_sel": [0, 11], "activ": [0, 7], "click": [0, 7, 13], "grid_voltag": [0, 7, 10, 12], "solis_grid_voltag": [0, 10], "battery_current_direct": [0, 10], "solis_battery_current_direct": [0, 10], "prepaid_unit": 0, "account": 0, "balanc": 0, "prepaid": 0, "config": 0, "so": [0, 7], "dont": 0, "them": [0, 2, 7], "innacur": 0, "169": 0, "altern": 0, "totalsolar": 0, "visualis": 0, "guid": [1, 3], "guidelin": 1, "help": 1, "maintain": 1, "commun": 1, "understand": 1, "reproduc": 1, "behaviour": 1, "find": [1, 7], "relat": 1, "creat": [1, 6, 13], "pleas": [1, 2, 7], "might": 1, "don": [1, 2], "t": [1, 2], "one": 1, "includ": [1, 13], "mani": [1, 13], "detail": 1, "possibl": 1, "ask": 1, "u": 1, "resolv": [1, 3], "issu": [1, 3, 4, 7], "faster": 1, "close": [1, 7], "seem": 1, "like": 1, "same": [1, 2], "thing": 1, "re": [1, 4], "experienc": 1, "open": [1, 2], "new": [1, 3, 4, 13], "link": 1, "origin": 1, "bodi": 1, "cursori": 1, "search": [1, 13], "problem": 1, "ha": [1, 3, 6, 7], "alreadi": 1, "still": 1, "add": [1, 3, 4, 7, 13], "comment": [1, 7], "exist": 1, "instead": 1, "track": [1, 3], "github": [1, 3, 4, 7, 12, 13], "after": 1, "ve": 1, "determin": 1, "configur": 1, "fill": 1, "templat": [1, 6], "explain": 1, "clear": [1, 3, 13], "identifi": 1, "describ": 1, "exact": 1, "step": 1, "exampl": [1, 3], "instal": [1, 2, 7], "plugin": [1, 3], "just": 1, "sai": 1, "what": 1, "did": 1, "lovelac": 1, "editor": [1, 7], "yaml": [1, 7], "directli": 1, "demonstr": 1, "screenshot": 1, "copi": [1, 2, 7, 13], "pasteabl": 1, "snippet": 1, "those": 1, "markdown": 1, "observ": 1, "point": [1, 13], "exactli": 1, "why": 1, "gif": 1, "clearli": 1, "chrome": 1, "develop": [1, 2, 12, 13, 14], "tool": 1, "pane": 1, "error": 1, "wasn": 1, "trigger": 1, "action": 1, "were": 1, "happen": 1, "share": 1, "context": [1, 3], "answer": 1, "question": 1, "recent": 1, "updat": [1, 3, 7], "version": [1, 13], "wa": 1, "alwai": [1, 3], "older": 1, "most": [1, 2, 7, 13], "doesn": 1, "atom": 1, "calendar": 1, "reviv": 1, "via": [1, 7, 12, 13], "hac": 1, "releas": [1, 3, 4], "page": [1, 12], "reliabl": 1, "about": 1, "often": 1, "condit": 1, "easiest": 2, "get": 2, "setup": [2, 7, 13], "dev": 2, "utilis": [2, 4], "docker": 2, "guarante": 2, "match": [2, 7], "remov": [2, 7], "potenti": 2, "headach": 2, "incompat": 2, "remot": [2, 3], "extens": 2, "recommend": [2, 13], "file": [2, 3, 4, 7], "past": [2, 7], "folder": [2, 3, 4], "filenam": [2, 13], "In": [2, 3, 7], "ensur": [2, 3], "xxx": 2, "would": [2, 7], "repositori": 2, "commit": 2, "prompt": 2, "reopen": 2, "now": [2, 3], "appear": 2, "build": [2, 4], "compon": [2, 7], "pre": 2, "notif": 2, "command": [2, 3, 4], "pallet": 2, "how": 3, "review": 3, "accept": 3, "fork": 3, "repo": [3, 4], "clone": 3, "project": 3, "machin": 3, "git": 3, "http": [3, 7, 12, 13], "com": [3, 7, 12], "usernam": 3, "work": [3, 7], "featur": 3, "bug": [3, 13, 14], "must": [3, 7], "latest": 3, "upstream": 3, "up": 3, "main": [3, 5], "slipx06": [3, 7, 13], "checkout": 3, "master": [3, 7], "fetch": 3, "merg": 3, "push": [3, 4], "sync": 3, "b": [3, 7], "_": 3, "100_fix": 3, "relev": 3, "short": 3, "fix": [3, 4, 7], "run": [3, 4], "yarn": [3, 4], "made": 3, "src": 3, "packag": [3, 7], "json": 3, "There": [3, 4], "autom": 3, "howev": [3, 7], "against": 3, "server": [3, 7, 12], "invert": [3, 13, 14], "advers": 3, "impact": 3, "ad": 3, "bugfix": 3, "semant": 3, "major": 3, "minor": 3, "patch": 3, "break": 3, "user": 3, "invervent": 3, "doe": [3, 6], "intervent": 3, "function": [3, 7], "backward": 3, "compat": 3, "manner": 3, "onc": 3, "happi": 3, "m": 3, "feat": 3, "messag": [3, 13], "convent": 3, "within": [3, 4, 7], "complet": 3, "pass": 3, "thei": 3, "member": [3, 7], "team": 3, "appropri": [3, 4], "built": 4, "sphinx": 4, "site": 4, "two": 4, "edit": [4, 7], "doc": [4, 7], "rais": 4, "someth": 4, "restructuredtext": 4, "directori": [4, 7, 13], "refer": [4, 13], "toc": 4, "rst": 4, "head": 4, "test": 4, "b6baa9": 5, "batteri": [5, 6, 8, 9, 10, 13], "33000": 5, "35": 5, "9000": 5, "solar": [5, 6, 7, 8, 9, 10, 13], "5000": [5, 7, 12], "south": 5, "f": 5, "r": 5, "north": [5, 10, 11], "load": [5, 6, 7, 8, 9, 10, 11, 12, 13], "hw": 5, "water": [5, 7, 9, 12], "kitchen": 5, "stove": [5, 11], "climat": 5, "mitsu": 5, "heat": [5, 10], "outlin": 5, "mirror": 5, "heater": 5, "rectangl": 5, "grid": [5, 6, 7, 8, 9, 10, 11, 13], "12000": 5, "entiti": [5, 6, 7, 8, 9, 10, 11, 12, 13], "emontx4_vrm": 5, "foxess_rcurr": 5, "foxess_rpow": 5, "foxess_inverter_st": 5, "foxess_battery_charge_todai": 5, "foxess_battery_discharge_todai": 5, "foxess_batvolt": 5, "foxess_battery_soc": 5, "foxess_invbatpow": 5, "foxess_invbatcurr": 5, "foxess_grid_consumption_energy_todai": 5, "foxess_feed_in_energy_todai": 5, "foxess_load_pow": 5, "foxess_grid_ct": 5, "foxess_load_energy_todai": 5, "essential_total_pow": 5, "emontx4_p3": 5, "aux_total_pow": 5, "foxess_solar_energy_todai": 5, "foxess_pv1_pow": 5, "foxess_pv2_pow": 5, "foxess_pv3_pow": 5, "foxess_pv1_voltag": 5, "foxess_pv1_curr": 5, "foxess_pv2_voltag": 5, "foxess_pv2_curr": 5, "foxess_pv3_voltag": 5, "foxess_pv3_curr": 5, "nonessential_load1": 5, "emontx4_p8": 5, "kitchen_pow": 5, "emontx4_p12": 5, "shlyclkrm_heater_pow": 5, "shlycloakroom_temperature_2": 5, "octopus_energy_electricity_xxx_yyy_current_r": 5, "octopus_energy_electricity_xxx_yyy_export_current_r": 5, "10650": 6, "goodwe_shutdown_soc": 6, "5400": 6, "east": [6, 11], "west": [6, 10, 11], "today_battery_discharg": 6, "today_battery_charg": 6, "today_load": 6, "today_s_pv_gener": 6, "on_grid_l1_voltag": 6, "on_grid_l2_voltag": 6, "on_grid_l3_voltag": 6, "meter_frequ": 6, "on_grid_l1_curr": 6, "on_grid_l2_curr": 6, "on_grid_l3_curr": 6, "pv1_power": 6, "pv2_power": 6, "pv_power": 6, "battery_voltag": 6, "battery_state_of_charg": 6, "battery_pow": 6, "battery_curr": 6, "house_consumpt": 6, "load_l1": 6, "load_l2": 6, "load_l3": 6, "active_power_l1": 6, "active_power_l2": 6, "active_power_l3": 6, "active_pow": 6, "pv1_voltag": 6, "pv1_current": 6, "pv2_voltag": 6, "pv2_current": 6, "grid_mode_cod": 6, "work_mode_cod": 6, "battery_temperatur": 6, "inverter_temperature_radi": 6, "inverter_temperature_air": 6, "energy_buy_daili": 6, "energy_sell_daili": 6, "energy_production_today_tot": 6, "spot_price_bui": 6, "spot_price_sel": 6, "depth": 6, "dod": 6, "depth_of_discharge_on_grid": 6, "mai": 6, "vari": 6, "languag": 6, "unique_id": 6, "arrow": 6, "down": 6, "int": 6, "feedback": 7, "discuss": 7, "support": [7, 13], "rove": 7, "ronin": 7, "istor": 7, "australia": 7, "huawei_derived_sensor": 7, "sunsynk_card_derived_sensor": 7, "homeassist": 7, "upon": 7, "restart": 7, "deriv": 7, "baselin": 7, "wlcr": 7, "popul": 7, "electricity_costs_xxx": 7, "tariff": 7, "plan": 7, "similiar": 7, "customis": [7, 13], "price": 7, "fit": 7, "reflect": 7, "period": 7, "tree": 7, "huawei_packag": 7, "whilst": 7, "simplest": 7, "disadvantag": 7, "later": 7, "devic": 7, "individu": 7, "unabl": 7, "do": 7, "gui": 7, "given": 7, "flexibl": 7, "done": 7, "go": 7, "servic": 7, "helper": 7, "button": [7, 13], "choic": 7, "sum": 7, "instruct": 7, "enter": 7, "id": 7, "purpos": 7, "sunsynk_card_aux_energy_daili": [7, 12], "consum": 7, "monitor": [7, 12], "aux1": 7, "aux2": 7, "sunsynk_card_aux_active_pow": [7, 12], "sunsynk_card_non_essential_active_pow": [7, 12], "tota": 7, "essntial": 7, "hvac": [7, 12], "charger": 7, "hot": 7, "some": 7, "enabl": 7, "variou": 7, "c": 7, "factor": 7, "yield": 7, "peak": 7, "effici": 7, "bu": 7, "control": 7, "Not": 7, "futur": 7, "envis": 7, "With": 7, "final": 7, "valid": 7, "suit": 7, "huawei_solar": 7, "well": 7, "zeronounour": 7, "prior": 7, "18px": [7, 12], "14850": [7, 12], "battery_end_of_discharge_soc": [7, 12], "fc8d83": [7, 12], "f7bc00": [7, 12], "6600": [7, 12], "inv1": [7, 12], "s1": [7, 12], "inv2": [7, 12], "magenta": [7, 12], "brown": [7, 11, 12], "IT": [7, 12], "network": [7, 12], "4000": [7, 12], "light": [7, 12], "gpo": [7, 12], "spare": [7, 12], "lightbulb": [7, 12], "plug": [7, 12], "kettl": [7, 12], "ff2400": [7, 12], "a40013": [7, 11, 12], "e7d59f": [7, 12], "fan": [7, 12], "car": [7, 12], "15000": [7, 9, 12], "null": [7, 10, 11, 12], "batteries_day_charg": [7, 12], "batteries_day_discharg": [7, 12], "house_consumption_energy_daili": [7, 12], "hs_grid_imported_daili": [7, 12], "hs_grid_exported_daili": [7, 12], "inverters_daily_yield": [7, 12], "power_meter_voltag": [7, 12], "power_meter_frequ": [7, 12], "house_consumption_pow": [7, 12], "inverter_phase_a_curr": [7, 12], "inverters_active_pow": [7, 12], "inverters_st": [7, 12], "inverters_internal_temperatur": [7, 12], "inverter_1_pv_1_pow": [7, 12], "inverter_1_pv_2_pow": [7, 12], "inverters_input_pow": 7, "your_loc": [7, 12], "_temp": [7, 12], "energy_production_today_remain": [7, 10, 12], "inverter_pv_1_voltag": [7, 12], "inverter_pv_1_curr": [7, 12], "inverter_pv_2_voltag": [7, 12], "inverter_pv_2_curr": [7, 12], "batteries_bus_voltag": [7, 12], "batteries_state_of_capac": [7, 12], "batteries_charge_discharge_pow": [7, 12], "batteries_bus_curr": [7, 12], "batteries_temperatur": [7, 12], "batteries_statu": [7, 12], "house_consumption_power_less_aux_non_essenti": [7, 12], "lights_all_active_pow": [7, 12], "gpo_all_active_power_less_known": [7, 12], "hvac_active_pow": [7, 12], "ev_charger_active_pow": [7, 12], "power_meter_active_pow": [7, 12], "inverters_off_grid_statu": [7, 12], "sunsynk_card_aux_connected_statu": [7, 12], "electricity_pric": [7, 12], "electricity_fit": [7, 12], "it_hardware_network_active_pow": [7, 12], "it_hardware_servers_active_pow": [7, 12], "env_network_rack_bme280_temperatur": [7, 12], "garage_controller_bme280_temperatur": [7, 12], "13200": 7, "s2": 7, "10000": 7, "inverter_2_pv_1_pow": 7, "inverter_2_pv_2_pow": 7, "inverter_pv_1_voltage_2": 7, "inverter_pv_1_current_2": 7, "inverter_pv_2_voltage_2": 7, "inverter_pv_2_current_2": 7, "aircon_active_pow": 7, "25000": 7, "power_meter_phase_a_voltag": 7, "power_meter_phase_b_voltag": 7, "power_meter_phase_c_voltag": 7, "inverter_phase_b_curr": 7, "inverter_phase_c_curr": 7, "shelly3em_phase_a_gpo_pow": 7, "shelly3em_phase_b_gpo_pow": 7, "shelly3em_phase_c_gpo_pow": 7, "power_meter_phase_a_active_pow": 7, "power_meter_phase_b_active_pow": 7, "power_meter_phase_c_active_pow": 7, "29700": 7, "20000": 7, "12800": 8, "rear": 8, "front": 8, "lux_grid_voltage_l": 8, "lux_grid_frequency_l": 8, "inverter_output_curr": 8, "lux_statu": 8, "lux_battery_flow_l": 8, "lux_battery_charge_daili": 8, "lux_battery_discharge_daili": 8, "lux_battery_voltage_l": 8, "lux_batteri": 8, "lux_battery_capacity_ah": 8, "lux_grid_flow_l": 8, "lux_power_from_grid_daili": 8, "lux_power_to_grid_daili": 8, "lux_power_from_inverter_to_home_daili": 8, "lux_home_consumption_l": 8, "aux_output_pow": 8, "lux_solar_output_daili": 8, "lux_solar_output_l": 8, "lux_solar_output_array_1_l": 8, "lux_solar_output_array_2_l": 8, "lux_solar_voltage_array_1_l": 8, "lux_solar_voltage_array_2_l": 8, "lux_radiator_1_temperature_l": 8, "lux_radiator_2_temperature_l": 8, "forecast_remaining_todai": 8, "energy_cost": 8, "octopus_energy_electricity_20e5081533_2380002009185_current_r": 8, "lxp_baxxxxxxxx_grid_voltag": 8, "lxp_baxxxxxxxx_eps_frequ": 8, "lxp_baxxxxxxxx_inverter_pow": 8, "lxp_baxxxxxxxx_battery_charge_todai": 8, "lxp_baxxxxxxxx_battery_discharge_todai": 8, "lxp_baxxxxxxxx_battery_voltag": 8, "lxp_baxxxxxxxx_battery_percentag": 8, "lxp_baxxxxxxxx_battery_power_discharge_is_neg": 8, "lxp_baxxxxxxxx_grid_power_export_is_neg": 8, "lxp_baxxxxxxxx_energy_from_grid_todai": 8, "lxp_baxxxxxxxx_energy_to_grid_todai": 8, "lxp_baxxxxxxxx_energy_of_inverter_todai": 8, "lxp_baxxxxxxxx_pv_generation_todai": 8, "lxp_baxxxxxxxx_power_pv_arrai": 8, "lxp_baxxxxxxxx_power_pv_string_1": 8, "lxp_baxxxxxxxx_power_pv_string_2": 8, "lxp_baxxxxxxxx_voltage_pv_string_1": 8, "lxp_baxxxxxxxx_voltage_pv_string_2": 8, "lxp_baxxxxxxxx_radiator_1_temperatur": 8, "lxp_baxxxxxxxx_radiator_2_temperatur": 8, "baxxxxxxxx": 8, "wifi": 8, "dongl": 8, "17600": 9, "3750": 9, "7000": 9, "thermomet": 9, "194": 9, "219": 9, "189": 9, "188": 9, "solax_run_mod": 9, "solax_inverter_voltag": 9, "solax_inverter_curr": 9, "solax_inverter_pow": 9, "solax_inverter_temperatur": 9, "solax_battery_input_energy_todai": 9, "solax_battery_output_energy_todai": 9, "solax_battery_voltage_charg": 9, "solax_battery_capac": 9, "solax_battery_power_charg": 9, "solax_battery_current_charg": 9, "solax_battery_temperatur": 9, "solax_today_s_import_energi": 9, "solax_today_s_export_energi": 9, "solax_grid_export_import_sum2": 9, "powerflow_today_house_load": 9, "solax_today_s_solar_energi": 9, "solax_pv_power_1": 9, "solax_pv_voltage_1": 9, "solax_pv_current_1": 9, "solcast_pv_forecast_forecast_remaining_todai": [9, 10], "immersion_current_consumpt": 9, "immersion_energy_dai": 9, "ev_power_consumpt": 9, "ev_fast_charge_dai": 9, "14400": 10, "pc": 10, "desktop": 10, "classic": 10, "tv": 10, "televis": 10, "grid_power_167": 10, "solis_inverter_meter_active_pow": 10, "solis_inverter_house_load": 10, "pc_socket_pow": 10, "smart_socket_3_pow": 10, "octopus_energy_electricity_xxxxx_xxxxxx_current_r": 10, "octopus_energy_electricity_xxxxxx_xxxxx_export_current_r": 10, "solis_inverter_inverter_temperatur": 10, "solis_inverter_inverter_voltag": 10, "solis_inverter_inverter_frequ": 10, "solis_inverter_inverter_curr": 10, "solis_inverter_active_pow": 10, "solis_inverter_battery_charge_todai": 10, "solis_inverter_battery_discharge_todai": 10, "solis_inverter_battery_voltag": 10, "solis_inverter_battery_soc": 10, "battery_load": 10, "solis_inverter_battery_curr": 10, "solis_inverter_grid_import_todai": 10, "solis_inverter_grid_export_todai": 10, "solis_inverter_house_load_todai": 10, "solis_inverter_power_generation_todai": 10, "solis_inverter_pv_total_pow": 10, "solis_inverter_pv_voltage_1": 10, "solis_inverter_pv_current_1": 10, "view_layout": 10, "area": 10, "415px": 10, "959595": 10, "f4c430": 10, "9600": 10, "14280": 10, "6000": 10, "geyser": [10, 11], "coil": 10, "pool": [10, 11], "solis_inverter_temperatur": 10, "solis_inverter_today_battery_charge_energi": 10, "solis_inverter_today_battery_discharge_energi": 10, "solis_inverter_today_energy_consumpt": 10, "solis_inverter_today_energy_imported_from_grid": 10, "solis_inverter_today_energy_fed_into_grid": 10, "solis_inverter_pv_today_energy_gener": 10, "solis_inverter_a_phase_voltag": 10, "solis_inverter_grid_frequ": 10, "solis_inverter_a_phase_curr": 10, "solis_inverter_backup_load_pow": 10, "solis_inverter_ac_grid_port_pow": 10, "solis_inverter_battery_pow": 10, "solis_inverter_meter_total_active_pow": 10, "solis_inverter_dc_voltage_1": 10, "solis_inverter_dc_current_1": 10, "solis_inverter_dc_power_1": 10, "solis_inverter_dc_voltage_2": 10, "solis_inverter_dc_current_2": 10, "solis_inverter_dc_power_2": 10, "solis_inverter_total_dc_output": 10, "solis_inverter_battery_current_direct": 10, "solis_inverter_current_statu": 10, "54": 10, "solis_inverter_voltag": 10, "solis_inverter_frequ": 10, "solis_inverter_curr": 10, "solis_inverter_ac_pow": 10, "solis_inverter_statu": 10, "solis_battery_voltag": 10, "solis_battery_soc_lead": 10, "solis_battery_pow": 10, "solis_battery_curr": 10, "solis_grid_active_power_neg": 10, "solis_daily_energy_import": 10, "solis_daily_energy_export": 10, "solis_daily_consumpt": 10, "solis_backup_load_pow": 10, "solis_pv1_voltag": 10, "solis_pv1_curr": 10, "solis_pv2_voltag": 10, "solis_pv2_curr": 10, "overall_st": 11, "air": 11, "filter": 11, "sunsynk_day_aux_energi": 11, "sunsynk_totalsolar": 11, "tuya_geyser_current_consumpt": 11, "load2_pow": 11, "daily_geyser_energi": 11, "load2_extra": 11, "nonessential1_pow": 11, "nonessential2_pow": 11, "sunsynk_aux_connected_statu": 11, "home_realfeel_temperatur": 11, "sunsynk_prog1_capac": 11, "sunsynk_prog1_grid_charg": 11, "sunsynk_prog2_capac": 11, "sunsynk_prog2_grid_charg": 11, "sunsynk_prog3_capac": 11, "sunsynk_prog3_grid_charg": 11, "sunsynk_prog4_capac": 11, "sunsynk_prog4_grid_charg": 11, "sunsynk_prog5_capac": 11, "sunsynk_prog5_grid_charg": 11, "sunsynk_prog6_capac": 11, "sunsynk_prog6_grid_charg": 11, "tibber_energy_cost_bui": 11, "tibber_energy_cost_sel": 11, "gesyer": 11, "pool_pump": 11, "pool_temperatur": 11, "nathanmarlor": 12, "foxess_modbu": 12, "white": 12, "emul": 13, "screen": 13, "long": 13, "io": 13, "index": 13, "html": 13, "between": 13, "style": 13, "dynam": 13, "slot": 13, "abil": 13, "bigger": 13, "assign": 13, "info": 13, "dialog": 13, "www": 13, "j": 13, "resourc": 13, "dashboard": 13, "ver": 13, "increment": 13, "download": 13, "forc": 13, "reload": 13, "avoid": 13, "cach": 13, "good": 13, "idea": 13, "browser": 13, "devcontain": [13, 14], "cycl": [13, 14], "document": 14}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"configur": [0, 2, 11, 13, 14], "invert": [0, 5, 6, 7, 8, 9, 10, 11, 12], "batteri": [0, 7, 11, 12], "solar": [0, 11, 12], "load": 0, "grid": [0, 12], "entiti": 0, "report": 1, "bug": 1, "befor": 1, "submit": [1, 3], "A": 1, "how": [1, 4], "do": 1, "i": 1, "v": 2, "code": 2, "devcontain": 2, "requir": [2, 7], "develop": 3, "cycl": 3, "setup": 3, "repositori": 3, "creat": [3, 7], "topic": 3, "branch": 3, "instal": [3, 13], "depend": 3, "make": 3, "chang": 3, "build": 3, "test": 3, "version": 3, "commit": 3, "pull": 3, "request": 3, "document": [4, 13], "contribut": [4, 13, 14], "ad": 4, "page": 4, "foxess": 5, "exampl": [5, 6, 7, 8, 9, 10, 12, 13, 14], "1": [5, 6, 7, 8, 9, 10, 12], "integr": [5, 8, 10], "via": [5, 10], "http": [5, 8, 10], "github": [5, 8, 10], "com": [5, 8, 10], "nathanmarlor": 5, "foxess_modbu": 5, "goodw": 6, "huawei": 7, "manual": [7, 13], "sensor": 7, "group": 7, "power": [7, 13], "meter": 7, "": 7, "luna": 7, "ess": 7, "x": 7, "l1": 7, "1phase": 7, "15kwh": 7, "2": [7, 8, 10], "pv": 7, "string": 7, "6": 7, "6kw": 7, "4": 7, "13": 7, "2kw": 7, "3": [7, 10], "m1": 7, "3phase": 7, "10kw": 7, "5": 7, "20kw": 7, "lux": 8, "us": [8, 13], "lxp": 8, "bridg": 8, "celsworth": 8, "solax": [9, 10], "soli": 10, "wills106": 10, "homeassist": 10, "modbu": 10, "s6": 10, "s2": 10, "wl": 10, "st": 10, "pho3nix90": 10, "solis_modbu": 10, "fboundi": 10, "ha_solis_modbu": 10, "sunsynk": [11, 13], "minimum": 11, "No": [11, 12], "minim": 11, "daili": 11, "total": 11, "full": 11, "all": 11, "option": 11, "victron": 12, "model": 12, "flow": 13, "card": 13, "featur": 13, "screenshot": 13, "hac": 13, "tabl": 13, "content": 13}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Configuration": [[0, "configuration"], [2, "configuration"], [13, null], [14, null]], "Inverter": [[0, "inverter"]], "Battery": [[0, "battery"]], "Solar": [[0, "solar"]], "Load": [[0, "load"]], "Grid": [[0, "grid"]], "Entities": [[0, "entities"]], "Reporting Bugs": [[1, "reporting-bugs"]], "Before Submitting A Bug Report": [[1, "before-submitting-a-bug-report"]], "How do i submit a bug report?": [[1, "how-do-i-submit-a-bug-report"]], "VS Code - DevContainer": [[2, "vs-code-devcontainer"]], "Requirements": [[2, "requirements"]], "Development Cycle": [[3, "development-cycle"]], "Setup Repository": [[3, "setup-repository"]], "Create Topic Branch": [[3, "create-topic-branch"]], "Install Dependencies": [[3, "install-dependencies"]], "Make changes & Build": [[3, "make-changes-build"]], "Testing": [[3, "testing"]], "Versioning": [[3, "versioning"]], "Commit Changes": [[3, "commit-changes"]], "Submit Pull Request": [[3, "submit-pull-request"]], "Documentation": [[4, "documentation"], [13, "documentation"]], "How to Contribute": [[4, "how-to-contribute"]], "Adding pages": [[4, "adding-pages"]], "FoxESS Inverter": [[5, "foxess-inverter"]], "Example 1 - Integration via https://github.com/nathanmarlor/foxess_modbus": [[5, "example-1-integration-via-https-github-com-nathanmarlor-foxess-modbus"]], "Goodwe Inverter": [[6, "goodwe-inverter"]], "Example 1": [[6, "example-1"], [8, "example-1"], [9, "example-1"]], "Huawei Inverter": [[7, "huawei-inverter"]], "REQUIRED MANUALLY CREATED SENSOR GROUPS:": [[7, "id1"]], "POWER METER:": [[7, "id2"]], "INVERTER(S):": [[7, "id3"]], "LUNA ESS BATTERY(S):": [[7, "id4"]], "Example 1 - 1 x L1 1phase inverter with a 15kWh LUNA ESS battery - 2 PV strings (6.6kW)": [[7, "example-1-1-x-l1-1phase-inverter-with-a-15kwh-luna-ess-battery-2-pv-strings-6-6kw"]], "Example 2 - 2 x L1 1phase inverter with a 15kWh LUNA ESS battery - 4 PV strings (13.2kW)": [[7, "example-2-2-x-l1-1phase-inverter-with-a-15kwh-luna-ess-battery-4-pv-strings-13-2kw"]], "Example 3 - 1 x M1 3phase inverter with a 15kWh LUNA ESS battery - 2 PV strings (10kW)": [[7, "example-3-1-x-m1-3phase-inverter-with-a-15kwh-luna-ess-battery-2-pv-strings-10kw"]], "Example 4 - 1 x M1 3phase inverters with 2 x 15kWh LUNA ESS batteries - 2 PV strings (10kW)": [[7, "example-4-1-x-m1-3phase-inverters-with-2-x-15kwh-luna-ess-batteries-2-pv-strings-10kw"]], "Example 5 - 2 x M1 3phase inverters with a 15kWh LUNA ESS battery - 4 PV strings (20kW)": [[7, "example-5-2-x-m1-3phase-inverters-with-a-15kwh-luna-ess-battery-4-pv-strings-20kw"]], "Lux Inverter": [[8, "lux-inverter"]], "Example 2 using the lxp-bridge integration (https://github.com/celsworth/lxp-bridge)": [[8, "example-2-using-the-lxp-bridge-integration-https-github-com-celsworth-lxp-bridge"]], "SolaX Inverter": [[9, "solax-inverter"]], "Solis Inverter": [[10, "solis-inverter"]], "Example 1 - Integration via https://github.com/wills106/homeassistant-solax-modbus": [[10, "example-1-integration-via-https-github-com-wills106-homeassistant-solax-modbus"]], "Example 2 (Solis S6 or S2-WL-ST) - Integration via https://github.com/Pho3niX90/solis_modbus": [[10, "example-2-solis-s6-or-s2-wl-st-integration-via-https-github-com-pho3nix90-solis-modbus"]], "Example 3 (Solis S6 or S2-WL-ST) - Integration via https://github.com/fboundy/ha_solis_modbus": [[10, "example-3-solis-s6-or-s2-wl-st-integration-via-https-github-com-fboundy-ha-solis-modbus"]], "Sunsynk Inverter": [[11, "sunsynk-inverter"]], "Minimum Configuration (No Solar, No Battery)": [[11, "minimum-configuration-no-solar-no-battery"]], "Minimum Configuration (Solar)": [[11, "minimum-configuration-solar"]], "Minimal Configuration (No Solar)": [[11, "minimal-configuration-no-solar"]], "Minimal Configuration (No Battery)": [[11, "minimal-configuration-no-battery"]], "Minimal Configuration (Solar and Battery)": [[11, "minimal-configuration-solar-and-battery"]], "Minimal Configuration (Solar + Daily Totals)": [[11, "minimal-configuration-solar-daily-totals"]], "Full Configuration (All Options)": [[11, "full-configuration-all-options"]], "Victron Inverters": [[12, "victron-inverters"]], "Example 1 - Victron with Battery / Solar / No Grid": [[12, "example-1-victron-model-with-battery-solar-no-grid"]], "Sunsynk-Power-Flow-Card": [[13, "sunsynk-power-flow-card"]], "Features": [[13, "features"]], "Screenshots": [[13, "screenshots"]], "Installation": [[13, "installation"]], "Installation using HACS": [[13, "installation-using-hacs"]], "Manual Installation": [[13, "manual-installation"]], "Table of Contents": [[13, "table-of-contents"]], "Examples": [[13, null], [14, null]], "Contribute": [[13, null], [14, null]]}, "indexentries": {}}) \ No newline at end of file diff --git a/toc.html b/toc.html new file mode 100644 index 00000000..8219a973 --- /dev/null +++ b/toc.html @@ -0,0 +1,172 @@ + + + + + + + <no title> — sunsynk-power-flow-card documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + + + + + \ No newline at end of file