Sphinx build from Action bffbb9d

.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: cf53a9ff03148ae706bfed8dcc171d80
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_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 <https://github.com/slipx06/sunsynk-power-flow-card/issues?q=is%3Aissue>`_
+  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 <https://guides.github.com/features/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 <https://github.com/slipx06/sunsynk-power-flow-card/issues/new?assignees=&labels=type%2Fbug&projects=&template=bug_report.yml>`_.
+
+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 <https://help.github.com/articles/markdown-basics/#multiple-lines>`_.
+- **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.

_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``

_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 <https://github.com/slipx06/sunsynk-power-flow-card>`_
+* 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 <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:
+
+.. 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 <http://semver.org>`_
+
+**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 <https://github.com/slipx06/sunsynk-power-flow-card/releases>`_
+
+
+**************
+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 <https://www.conventionalcommits.org/en/v1.0.0/>`_
+    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

_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 <https://www.sphinx-doc.org/en/master/usage/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``

_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