pypvs 0.1.3__tar.gz

pypvs-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 SunStrong Management
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pypvs-0.1.3/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+recursive-include doc *
+recursive-include examples *

pypvs-0.1.3/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: pypvs
+Version: 0.1.3
+Summary: A Python package that exposes data and commands for a Sunpower PVS6 gateway.
+Home-page: https://github.com/SunStrong-Management/pypvs.git
+Author: Aleksandar Mitev @ SunStrong Management
+Author-email: Aleksandar Mitev <amitev@sunstrongmanagement.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/SunStrong-Management/pypvs
+Project-URL: Issues, https://github.com/SunStrong-Management/pypvs/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# pypvs
+
+`pypvs` is a Python package that exposes data and commands for a Sunpower PVS6 gateway
+
+## Installation
+
+You can install it using pip:
+```
+pip install pypvs
+```
+
+# Running the examples
+
+Initialize virtual environment and install requirements
+```
+virtualenv venv
+. venv/bin/activate
+pip install -r requirements.txt
+```
+
+Install `pypvs` in development mode
+```
+pip install -e .
+```
+
+Then run the example scripts
+```
+python examples/simple_fcgi_async.py
+
+python examples/simple_pvs_async.py
+```
+
+# Access to the PVS via varserver
+
+Please refer to [LocalAPI documentation](doc/LocalAPI.md) for details on accessing the PVS via varserver.
+

pypvs-0.1.3/README.md

@@ -0,0 +1,36 @@
+# pypvs
+
+`pypvs` is a Python package that exposes data and commands for a Sunpower PVS6 gateway
+
+## Installation
+
+You can install it using pip:
+```
+pip install pypvs
+```
+
+# Running the examples
+
+Initialize virtual environment and install requirements
+```
+virtualenv venv
+. venv/bin/activate
+pip install -r requirements.txt
+```
+
+Install `pypvs` in development mode
+```
+pip install -e .
+```
+
+Then run the example scripts
+```
+python examples/simple_fcgi_async.py
+
+python examples/simple_pvs_async.py
+```
+
+# Access to the PVS via varserver
+
+Please refer to [LocalAPI documentation](doc/LocalAPI.md) for details on accessing the PVS via varserver.
+

pypvs-0.1.3/doc/LocalAPI.md

@@ -0,0 +1,281 @@
+# Local Monitoring using FCGI Web Services
+SunStrong Management is pleased to announce an API for local PVS monitoring.  The API is available on the PVS Ethernet and Wi-Fi interfaces and can be used to access some of the legacy dl_cgi APIs as well as the new varserver FCGI APIs.
+
+These APIs will support local communication between the PVS and the SunStrong Connect application, as well as custom monitoring solutions developed by system owners and the open source development community.
+
+The interface supports Basic Authentication (username/password).  Users must authenticate before accessing the dl_cgi and FCGI APIs.  Some limited Varserver data points and dl_cgi endpoints are available without authentication.
+
+Varserver is a highly efficient in-memory key-value data store used for system configuration management, telemetry reporting, and inter-process communications.  Data is stored/retrieved as unstructured primitive data points which represent a single telemetry value or configuration/control point.  Some data is represented as JSON object structures stored in string variables.
+
+The Varserver web services only expose two APIs:
+
+- auth - user login/logout
+
+- vars - Varserver interface for setting and getting variables
+
+## Our commitment to open source
+The SunStrong Management team have made available the following open source components to support the community:
+
+- A Python wrapper around the VarServer FCGI web services (PyPVS)
+
+- A Home Assistant plugin which can be installed in Home Assistant via the Home Assistant Community Store (HACS).
+
+### Availability
+The FCGI Web services and authenticated dl_cgi endpoints are available in PVS6 firmware build 61840 and later.  Support for PVS5 devices is coming soon.  PVS2 devices are not, and will never be supported.
+
+### Disclaimer
+Use of this interface is at your own risk.  SunStrong Management is releasing these components as-is, and assume no liability for use/mis-use of these components. 
+
+## Theory of Operation
+For most users, the PyPVS library and HA plugin will be sufficient to get started, but for those interested in the more technical details of the API, read on….
+
+### Authentication
+Before accessing data, users must authenticate against the PVS using a username and password.  The username is: ssm_owner
+The password is: the last 5 characters of the PVS serial number
+
+Upon successful login, the requester receives an access token which is then delivered (via a cookie) to the PVS in subsequent data queries.  
+
+### Data queries:
+Data points can be queried by name; by partial name match; by tags; and by cache id.  Any query can be associated with a user specified cache id, and then subsequently retrieved using that cache id.  Users can arbitrarily group data points as needed and retrieve those groupings by cache id.  Note that match queries search the entire varserver name space and are less efficient than cached queries.  It is strongly recommended, particularly when making frequent match or tag queries, to cache the query, and then make subsequent queries using the cache id.   While the varserver FCGI interface is very efficient, we do not recommend making queries faster than once every few seconds, in case you overload the PVS CPU.  This is particularly important on SunVault systems where the CPU already has a lot to do.
+
+### Data Output Formats
+Two data output formats are currently supported:
+
+- a JSON array containing one object per data point with name and value, and possibly other attributes in future
+
+- a JSON object containing key/value pairs, where the key is the datapoint name, and the value is its current value.
+
+### Available data points
+This list is subject to change, and we will most likely not be updating it regularly.  To check the data points available on your system, run a match query, but beware this will generate a lot of data.
+
+Check the attached file [Varserver Variables](varserver-variables-public.csv) for the list of currenlty accessible variables.
+
+### Examples
+All the examples are shown below using curl to demonstrate the API features.
+in all the examples below:
+
+- **pwd** = <last 5 digits of PVS serial number>
+- **ip** = <IP address of PVS>
+- **cookies.txt** is a file containing cookies (used to store auth tokens)
+
+The `jq` utility is used to format the response into a more readable format
+
+#### Authentication - login
+```
+$ auth=`echo -n "ssm_owner:$pwd" | base64`
+$ curl -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       -H "Authorization: basic $auth" \
+       https://$ip/auth?login 
+{"session": "3z02Z55QKi4VZevR6EW4psExaTNZaiaGGeUBqKlXnHIJBPoPV6uzztgcAXGd3rFf" }
+$ cat cookies.txt
+# Netscape HTTP Cookie File
+# https://curl.se/docs/http-cookies.html
+# This file was generated by libcurl! Edit at your own risk.
+#HttpOnly_localhost     FALSE   /       TRUE    0       session NCA7CIW7zoXxsFfWAH64OrrNS6OrN2zU0hTAcgtUvCMqOsug98TldqceGBxI2ZxK
+```
+
+#### Authentication - logout
+```
+$ curl -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       -H "Authorization: basic $auth" \
+       https://$ip/auth?logout 
+```
+
+#### Query a list of variables by name
+```
+$ curl -s \
+       -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       https://$ip/vars?name=/sys/info/sw_rev,/sys/info/lmac | jq
+{
+  "values": [
+    {
+      "name": "/sys/info/sw_rev",
+      "value": "2025.06.24.61840"
+    },
+    {
+      "name": "/sys/info/lmac",
+      "value": "00:22:F2:13:85:54"
+    }
+  ],
+  "count": 2
+}
+```
+
+#### Query all variables which match a substring
+```
+$ curl -s \
+       -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       https://$ip/vars?match=rev | jq
+{
+  "values": [
+    {
+      "name": "/sys/info/hwrev",
+      "value": "6.03"
+    },
+    {
+      "name": "/sys/info/fwrev",
+      "value": " Major 2, Revision 0x00000001, Build 3"
+    },
+    {
+      "name": "/sys/info/sw_rev",
+      "value": "2025.06.24.61840"
+    }
+  ],
+  "count": 3
+}
+```
+
+#### Query all variables which match a substring and output as an object
+```
+$ curl -s \
+       -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       "https://$ip/vars?match=rev&fmt=obj" | jq
+{
+  "/sys/info/hwrev": "6.03",
+  "/sys/info/fwrev": " Major 2, Revision 0x00000001, Build 3",
+  "/sys/info/sw_rev": "2025.06.24.61840"
+}
+```
+
+#### Query all livedata power values using a match expression, create a cache, and output as an object
+```
+$ curl -s \
+       -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       "https://$ip/vars?match=livedata&fmt=obj&cache=ldata" | jq
+{
+  "/sys/livedata/time": "1751083263",
+  "/sys/livedata/pv_p": "0.015622",
+  "/sys/livedata/pv_en": "40747.871094",
+  "/sys/livedata/net_p": "0.674694",
+  "/sys/livedata/net_en": "6121.310059",
+  "/sys/livedata/site_load_p": "1.876316",
+  "/sys/livedata/site_load_en": "46378.703125",
+  "/sys/livedata/ess_en": "-490.477997",
+  "/sys/livedata/ess_p": "1.186000",
+  "/sys/livedata/soc": "0.860000",
+  "/sys/livedata/backupTimeRemaining": "570",
+  "/sys/livedata/midstate": "2"
+}
+```
+
+#### Query a cached data set and output as an object
+```
+$ curl -s \
+       -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       "https://$ip/vars?fmt=obj&cache=ldata" | jq
+{
+  "/sys/livedata/time": "1751083345",
+  "/sys/livedata/pv_p": "0.023758",
+  "/sys/livedata/pv_en": "40747.871094",
+  "/sys/livedata/net_p": "0.653675",
+  "/sys/livedata/net_en": "6121.330078",
+  "/sys/livedata/site_load_p": "2.539433",
+  "/sys/livedata/site_load_en": "46378.734375",
+  "/sys/livedata/ess_en": "-490.463989",
+  "/sys/livedata/ess_p": "1.862000",
+  "/sys/livedata/soc": "0.860000",
+  "/sys/livedata/backupTimeRemaining": "555",
+  "/sys/livedata/midstate": "2"
+}
+```
+
+#### Query all meter data values using a match expression, create a cache, and output as an object
+```
+$ curl -s \
+       -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       "https://$ip/vars?match=meter/data&fmt=obj&cache=mdata" | jq
+{
+  "/sys/devices/11/meter/data": {
+    "ctSclFctr": 50,
+    "freqHz": 60.0150032,
+    "msmtEps": "2025-06-28T04:10:00Z",
+    "netLtea3phsumKwh": 40747.87,
+    "p3phsumKw": 0.0158712063,
+    "prodMdlNm": "PVS6M0400p",
+    "q3phsumKvar": 1.25327051,
+    "s3phsumKva": 1.26208436,
+    "sn": "PVS6M23084354p",
+    "totPfRto": 0.00977255497,
+    "v12V": 248.283142,
+    "vldFldMsk": "67174655"
+  },
+  "/sys/devices/12/meter/data": {
+    "ctSclFctr": 300,
+    "freqHz": 60.0150032,
+    "i1A": 13.9226713,
+    "i2A": 12.32792,
+    "msmtEps": "2025-06-28T04:10:00Z",
+    "negLtea3phsumKwh": 13600.36,
+    "netLtea3phsumKwh": 6121.360000000001,
+    "p1Kw": 0.316900551,
+    "p2Kw": 0.16260837,
+    "p3phsumKw": 0.479508936,
+    "posLtea3phsumKwh": 19721.78,
+    "prodMdlNm": "PVS6M0400c",
+    "q3phsumKvar": -3.15799665,
+    "s3phsumKva": 3.25863361,
+    "sn": "PVS6M23084354c",
+    "totPfRto": 0.196262509,
+    "v12V": 248.283142,
+    "v1nV": 124.040031,
+    "v2nV": 124.243462,
+    "vldFldMsk": "70239999"
+  }
+}
+```
+
+#### Query all inverter data, create a cache, and output as an object
+```
+$ curl -s \
+       -k \
+       -b cookies.txt \
+       -c cookies.txt \
+       "https://$ip/vars?match=inverter/data&fmt=obj&cache=mdata" | jq
+{
+  "/sys/devices/21/inverter/data": {
+    "freqHz": 60.01,
+    "iMppt1A": 0.03,
+    "ltea3phsumKwh": 686.5164000000001,
+    "msmtEps": "2025-06-28T03:35:00Z",
+    "pMppt1Kw": 0.00068,
+    "prodMdlNm": "AC_Module_Type_H",
+    "sn": "E00122307107854",
+    "tHtsnkDegc": 24,
+    "vMppt1V": 17.93,
+    "vldFld2Msk": "1",
+    "vldFldMsk": "8125",
+    "vln3phavgV": 249.54
+  },
+  ...
+  "/sys/devices/61/inverter/data": {
+    "freqHz": 60.01,
+    "iMppt1A": 0.04,
+    "ltea3phsumKwh": 731.5522,
+    "msmtEps": "2025-06-28T03:35:00Z",
+    "pMppt1Kw": 0.00058,
+    "prodMdlNm": "AC_Module_Type_H",
+    "sn": "E00122308008125",
+    "tHtsnkDegc": 24,
+    "vMppt1V": 13.09,
+    "vldFld2Msk": "1",
+    "vldFldMsk": "8125",
+    "vln3phavgV": 249.84
+  }
+}
+```

pypvs-0.1.3/doc/varserver-variables-public.csv

@@ -0,0 +1,106 @@
+name,type,value,tags,description,read,write
+/sys/telemetryws/enable,uint16,1,N/A,Variable to enable telemetry websockets,ssm_owner,ssm_owner
+/sys/livedata/time,int64,N/A,livedata,Telemetry Websockets timestamp,ssm_owner,
+/sys/livedata/pv_p,float,N/A,livedata,Production Power (kW),ssm_owner,
+/sys/livedata/pv_en,float,N/A,livedata,Production Energy (kWh),ssm_owner,
+/sys/livedata/net_p,float,N/A,livedata,Net Consumption Power (kW),ssm_owner,
+/sys/livedata/net_en,float,N/A,livedata,Net Consumption Energy (kWh),ssm_owner,
+/sys/livedata/site_load_p,float,N/A,livedata,Site Load Power (kW),ssm_owner,
+/sys/livedata/site_load_en,float,N/A,livedata,Site Load Energy (kWh),ssm_owner,
+/sys/livedata/ess_en,float,N/A,livedata,Battery Energy (kWh),ssm_owner,
+/sys/livedata/ess_p,float,N/A,livedata,Battery Power (kW),ssm_owner,
+/sys/livedata/soc,float,N/A,livedata,Battery State of Charge (%),ssm_owner,
+/sys/livedata/backupTimeRemaining,uint32,N/A,livedata,Battery Backup Time Remaining (minutes),ssm_owner,
+/sys/livedata/midstate,int32,N/A,livedata,MID State,ssm_owner,
+/network/report/send,uint16,N/A,N/A,Trigger communicator to send a network interface report,ssm_owner,ssm_owner
+/metrics/network/interface_report_request,uint32,N/A,"metrics,network",Count of Network Interface Report requests,ssm_owner,ssm_owner
+/sys/info/serialnum,str,TBD,diag,PVS Serial Number,ssm_owner,
+/sys/info/model,str,TBD,diag,PVS model number,ssm_owner,
+/sys/info/hwrev,str,TBD,diag,PVS Hardware Revision,ssm_owner,
+/sys/info/uptime,str,TBD,diag,PVS uptime,ssm_owner,
+/sys/info/fwrev,str,TBD,diag,PVS Firmware Revision,ssm_owner,
+/sys/info/boardtype,str,TBD,diag,PVS Board Type,ssm_owner,
+/sys/info/sw_rev,str,TBD,diag,SPWR Software Revision,ssm_owner,
+/sys/info/ssid,str,TBD,diag,PVS ssid,ssm_owner,
+/sys/info/wpa_key,str,TBD,diag,PVS wpa key,ssm_owner,
+/sys/info/lmac,str,TBD,diag,LAN0 MAC address,ssm_owner,
+/sys/info/sys_type,str,Unknown,diag,"system type (PV-only, storage)",ssm_owner,
+/sys/info/finance_type,str,UNKNOWN,diag,"Finance type for the site that this PVS is running at. Viable values are UNKNOWN, CASH, LEASE, and LOAN",ssm_owner,
+/sys/info/active_interface,str,TBD,diag,Current active network interface,ssm_owner,
+/sys/info/active_interface_mac,str,TBD,diag,Current active network interface mac address,ssm_owner,
+/sys/info/ram_usage,uint16,0,diag,Current RAM usage in percentage,ssm_owner,
+/sys/info/flash_usage,uint16,0,diag,Current Flash usage in percentage,ssm_owner,
+/sys/info/cpu_usage,uint16,0,diag,Current CPU usage in percentage,ssm_owner,
+/sys/pvs/flashwear_type_b,uint16,0x05,sysstats,"Percentage lifetime estimation as HEX value (0x01 = 10%, 0x9 = 90%). E.g. 0x1 means that 10% of the EMMC lifetime passed. This value holds current value for TYPE B cell.",ssm_owner,
+/sys/pvs/usb_erase_count,uint16,0,sysstats,SMART Attribute 229 Erase Count Usage which is a measurement to tell the health state of USB drive.,ssm_owner,
+/sys/toggle_cell/low_data_mode,uint32,0,"netstats,toggle_cell",toggle_cell low data mode status,ssm_owner,
+/sys/toggle_cell/cell_connected,uint16,0,"netstats,toggle_cell","Cell connection status, 0=disconnected, 1=connected",ssm_owner,
+/sys/toggle_cell/broadband_connected,uint16,0,"netstats,toggle_cell","Broadband connection status, 0=disconnected, 1=connected",ssm_owner,
+/net/wwan0/state,str,N/A,"netstats,network,toggle_cell",wwan0 interface state,ssm_owner,
+/net/wan0/state,str,N/A,"netstats,network,toggle_cell",wan0 interface state,ssm_owner,
+/net/wan1/state,str,N/A,"netstats,network,toggle_cell",wan1 (USB dongle ethernet adapter) interface state,ssm_owner,
+/net/sta0/state,str,N/A,"netstats,network,toggle_cell",sta0 interface state,ssm_owner,
+/sys/devices/inverter/{index}/freqHz,float,0,"telemetry,inverter",Frequency in Hz dectected by the inverter,ssm_owner,
+/sys/devices/inverter/{index}/i3phsumA,float,0,"telemetry,inverter",Sum of phase currents in A,ssm_owner,
+/sys/devices/inverter/{index}/iMppt1A,float,0,"telemetry,inverter",Current of MPPT1 in A,ssm_owner,
+/sys/devices/inverter/{index}/ltea3phsumKwh,float,0,"telemetry,inverter",Lifetime sum of 3-phase energy in kWh,ssm_owner,
+/sys/devices/inverter/{index}/msmtEps,str,n/a,"telemetry,inverter",Timestamp of the last measurement,ssm_owner,
+/sys/devices/inverter/{index}/p3phsumKw,float,0,"telemetry,inverter",Sum of 3-phase power in kW,ssm_owner,
+/sys/devices/inverter/{index}/pMppt1Kw,float,0,"telemetry,inverter",Power of MPPT1 in kW,ssm_owner,
+/sys/devices/inverter/{index}/prodMdlNm,str,n/a,"telemetry,inverter",Product model name,ssm_owner,
+/sys/devices/inverter/{index}/sn,str,n/a,"telemetry,inverter",Serial number of the inverter,ssm_owner,
+/sys/devices/inverter/{index}/tHtsnkDegc,int32,0,"telemetry,inverter",Temperature of the heat sink in °C,ssm_owner,
+/sys/devices/inverter/{index}/vMppt1V,float,0,"telemetry,inverter",Voltage of MPPT1 in V,ssm_owner,
+/sys/devices/inverter/{index}/vln3phavgV,float,0,"telemetry,inverter",Average line-to-neutral voltage of 3-phase system in V,ssm_owner,
+/sys/devices/ess/{index}/chrgLimitPmaxKw,float,0,"telemetry,ess",Maximum allowed charge power (kW),ssm_owner,
+/sys/devices/ess/{index}/customerSocVal,float,0,"telemetry,ess",Customer-reported state of charge (SOC) value,ssm_owner,
+/sys/devices/ess/{index}/dischrgLimPmaxKw,float,0,"telemetry,ess",Maximum allowed discharge power (kW),ssm_owner,
+/sys/devices/ess/{index}/maxTBattCellDegc,float,0,"telemetry,ess",Maximum battery cell temperature (°C),ssm_owner,
+/sys/devices/ess/{index}/maxVBattCellV,float,0,"telemetry,ess",Maximum battery cell voltage (V),ssm_owner,
+/sys/devices/ess/{index}/minTBattCellDegc,float,0,"telemetry,ess",Minimum battery cell temperature (°C),ssm_owner,
+/sys/devices/ess/{index}/minVBattCellV,float,0,"telemetry,ess",Minimum battery cell voltage (V),ssm_owner,
+/sys/devices/ess/{index}/msmtEps,str,n/a,"telemetry,ess",Timestamp of the last measurement,ssm_owner,
+/sys/devices/ess/{index}/negLtea3phsumKwh,float,0,"telemetry,ess",Total negative energy (kWh) over 3 phases,ssm_owner,
+/sys/devices/ess/{index}/opMode,str,n/a,"telemetry,ess",Operating mode of the ESS,ssm_owner,
+/sys/devices/ess/{index}/p3phsumKw,float,0,"telemetry,ess",Total real power (kW) over 3 phases,ssm_owner,
+/sys/devices/ess/{index}/posLtea3phsumKwh,float,0,"telemetry,ess",Total positive energy (kWh) over 3 phases,ssm_owner,
+/sys/devices/ess/{index}/prodMdlNm,str,n/a,"telemetry,ess",Product model name,ssm_owner,
+/sys/devices/ess/{index}/sn,str,n/a,"telemetry,ess",Device serial number,ssm_owner,
+/sys/devices/ess/{index}/socVal,float,0,"telemetry,ess",State of charge (SOC) value,ssm_owner,
+/sys/devices/ess/{index}/sohVal,int16,0,"telemetry,ess",State of health (SOH) value,ssm_owner,
+/sys/devices/ess/{index}/tInvtrDegc,float,0,"telemetry,ess",Inverter temperature (°C),ssm_owner,
+/sys/devices/ess/{index}/v1nV,float,0,"telemetry,ess",Voltage between phase 1 and neutral (V),ssm_owner,
+/sys/devices/ess/{index}/v2nV,float,0,"telemetry,ess",Voltage between phase 2 and neutral (V),ssm_owner,
+/sys/devices/ess/{index}/vBattV,float,0,"telemetry,ess",Battery voltage (V),ssm_owner,
+/sys/devices/meter/{index}/ctSclFctr,int32,0,"telemetry,meter",CT scaling factor,ssm_owner,
+/sys/devices/meter/{index}/freqHz,float,0,"telemetry,meter",Frequency in Hz,ssm_owner,
+/sys/devices/meter/{index}/i1A,float,0,"telemetry,meter",Current in A for phase 1,ssm_owner,
+/sys/devices/meter/{index}/i2A,float,0,"telemetry,meter",Current in A for phase 2,ssm_owner,
+/sys/devices/meter/{index}/msmtEps,str,n/a,"telemetry,meter",Timestamp of the last measurement,ssm_owner,
+/sys/devices/meter/{index}/negLtea3phsumKwh,float,0,"telemetry,meter",Negative lifetime sum of 3-phase energy in kWh,ssm_owner,
+/sys/devices/meter/{index}/netLtea3phsumKwh,float,0,"telemetry,meter",Net lifetime sum of 3-phase energy in kWh,ssm_owner,
+/sys/devices/meter/{index}/p1Kw,float,0,"telemetry,meter",Power in kW for phase 1,ssm_owner,
+/sys/devices/meter/{index}/p2Kw,float,0,"telemetry,meter",Power in kW for phase 2,ssm_owner,
+/sys/devices/meter/{index}/p3phsumKw,float,0,"telemetry,meter",Sum of 3-phase power in kW,ssm_owner,
+/sys/devices/meter/{index}/posLtea3phsumKwh,float,0,"telemetry,meter",Positive lifetime sum of 3-phase energy in kWh,ssm_owner,
+/sys/devices/meter/{index}/prodMdlNm,str,n/a,"telemetry,meter",Product model name,ssm_owner,
+/sys/devices/meter/{index}/q3phsumKvar,float,0,"telemetry,meter",Sum of 3-phase reactive power in kVar,ssm_owner,
+/sys/devices/meter/{index}/s3phsumKva,float,0,"telemetry,meter",Sum of 3-phase apparent power in kVA,ssm_owner,
+/sys/devices/meter/{index}/sn,str,n/a,"telemetry,meter",Serial number of the meter,ssm_owner,
+/sys/devices/meter/{index}/totPfRto,float,0,"telemetry,meter",Total power factor ratio,ssm_owner,
+/sys/devices/meter/{index}/v12V,float,0,"telemetry,meter",Voltage between phase 1 and 2 in V,ssm_owner,
+/sys/devices/meter/{index}/v1nV,float,0,"telemetry,meter",Voltage between phase 1 and neutral in V,ssm_owner,
+/sys/devices/meter/{index}/v2nV,float,0,"telemetry,meter",Voltage between phase 2 and neutral in V,ssm_owner,
+/sys/devices/transfer_switch/{index}/midStEnum,str,n/a,"telemetry,transfer_switch",MID state,ssm_owner,
+/sys/devices/transfer_switch/{index}/msmtEps,str,n/a,"telemetry,transfer_switch",Timestamp of the last measurement,ssm_owner,
+/sys/devices/transfer_switch/{index}/prodMdlNm,str,n/a,"telemetry,transfer_switch",Product model name,ssm_owner,
+/sys/devices/transfer_switch/{index}/pvd1StEnum,str,n/a,"telemetry,transfer_switch",PV Disconnect (PVD) state,ssm_owner,
+/sys/devices/transfer_switch/{index}/sn,str,n/a,"telemetry,transfer_switch",Serial number of the transfer switch,ssm_owner,
+/sys/devices/transfer_switch/{index}/tDegc,float,0,"telemetry,transfer_switch",Temperature in degrees Celsius,ssm_owner,
+/sys/devices/transfer_switch/{index}/v1nGridV,float,0,"telemetry,transfer_switch",Grid voltage for phase 1,ssm_owner,
+/sys/devices/transfer_switch/{index}/v1nV,float,0,"telemetry,transfer_switch",Voltage between phase 1 and neutral,ssm_owner,
+/sys/devices/transfer_switch/{index}/v2nGridV,float,0,"telemetry,transfer_switch",Grid voltage between phase 2 and neutral,ssm_owner,
+/sys/devices/transfer_switch/{index}/v2nV,float,0,"telemetry,transfer_switch",Voltage between phase 2 and neutral,ssm_owner,
+/sys/devices/transfer_switch/{index}/vSpplyV,float,0,"telemetry,transfer_switch",Supply voltage,ssm_owner,
+/ess/config/dcm/mode_param/control_mode,str,STANDBY,"ess,config",ESS control mode,ssm_owner,ssm_owner
+/ess/config/dcm/control_param/min_customer_soc,float,0.30,"ess,config","Minimal customer SoC is used to calculate corresponding system soc threshold min_soc, should be between 0.0 and 1.0 including borders",ssm_owner,ssm_owner

pypvs-0.1.3/examples/simple_fcgi_async.py

@@ -0,0 +1,35 @@
+# This example demonstrates how to use the PVSFCGIClient class to
+# interact with a Sunpower PVS6 gateway using basic authentication.
+#
+
+import asyncio
+import aiohttp
+import logging
+
+from pypvs.pvs_fcgi import PVSFCGIClient
+
+logging.basicConfig(level=logging.DEBUG)
+
+# Example
+async def main():
+    async with aiohttp.ClientSession() as session:
+        pvs_serial = "ZT192585000549A1072"
+        # The username is: ssm_owner
+        # The password is: the last 5 characters of the PVS serial number
+        client = PVSFCGIClient(session, auth_user="ssm_owner", auth_password=pvs_serial[-5:])
+        client.pvs_url = "https://localhost:18443"  # Replace with your PVS URL
+
+        # Use basic authentication with the username and password
+        client.set_pvs_details({
+            "serial": pvs_serial
+        })
+
+        # We don't need to call login_basic() because refresh of the session cookies
+        # is handled automatically by the PVSFCGIClient class.
+        # await client.login_basic()
+
+        response = await client.execute_post_request("/vars", params={"name": "/sys/info/uptime"})
+        print(f"Response: {response}")
+
+if __name__ == "__main__":
+    asyncio.run(main())

pypvs-0.1.3/examples/simple_pvs_async.py

@@ -0,0 +1,53 @@
+# This is an example of how to use the PVS class to get data
+# from a Sunpower PVS6 gateway using asyncio.
+#
+
+import time
+import asyncio
+import aiohttp
+import logging
+
+from pypvs.pvs import PVS
+from pypvs.exceptions import ENDPOINT_PROBE_EXCEPTIONS
+
+logging.basicConfig(level=logging.DEBUG)
+
+async def fetch_data(pvs):
+    # get the uptime
+    uptime = await pvs.getVarserverVar("/sys/info/uptime")
+    # print both the uptime and the local time
+    print(f">>>>>> Uptime: {uptime}, Local time: {time.time()}")
+
+    livedata = await pvs.getVarserverVars("/sys/livedata")
+    # print livedata well formatted
+    print(">>>>>> LiveData:")
+    for key, value in livedata.items():
+        print(f"{key}: {value}")
+
+# Example
+async def main():
+    host = "192.168.11.29"
+
+    async with aiohttp.ClientSession() as session:
+        pvs = PVS(session=session, host=host, user="ssm_owner")
+        try:
+            await pvs.discover()
+            pvs_serial = pvs.serial_number
+            # The password is the last 5 characters of the PVS serial number
+            pvs_password = pvs_serial[-5:]
+            await pvs.setup(auth_password=pvs_password)
+            logging.info(f"Connected to PVS with serial: {pvs_serial}")
+        except ENDPOINT_PROBE_EXCEPTIONS as e:
+            logging.error(f"Cannot communicate with the PVS: {e}")
+            return
+
+        # setup a periodic task to fetch data every 5 seconds
+        while True:
+            await fetch_data(pvs)
+            await asyncio.sleep(5)
+
+if __name__ == "__main__":
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        print("Exiting...")

pypvs-0.1.3/examples/updater_ess_async.py

@@ -0,0 +1,58 @@
+# This is an example of how to use a PVS updater to get data
+#
+
+import asyncio
+import aiohttp
+
+from pypvs.pvs import PVS
+from pypvs.updaters.ess import PVSESSUpdater
+from pypvs.models.pvs import PVSData
+from pypvs.models.common import CommonProperties
+from pypvs.const import SupportedFeatures
+from pypvs.exceptions import ENDPOINT_PROBE_EXCEPTIONS
+
+import logging
+logging.basicConfig(level=logging.DEBUG)
+
+# Example
+async def main():
+    host = "localhost:18443"
+
+    async with aiohttp.ClientSession() as session:
+        pvs = PVS(session=session, host=host, user="ssm_owner")
+        try:
+            await pvs.discover()
+            pvs_serial = pvs.serial_number
+            # The password is the last 5 characters of the PVS serial number
+            pvs_password = pvs_serial[-5:]
+            await pvs.setup(auth_password=pvs_password)
+            logging.info(f"Connected to PVS with serial: {pvs_serial}")
+        except ENDPOINT_PROBE_EXCEPTIONS as e:
+            logging.error(f"Cannot communicate with the PVS: {e}")
+            return
+
+        common_properties = CommonProperties()
+        ess_updater = PVSESSUpdater(pvs.getVarserverVar, pvs.getVarserverVars, common_properties)
+
+        discovered_features = SupportedFeatures(0)
+        ess_is_there = await ess_updater.probe(discovered_features)
+        if not ess_is_there:
+            print("No ESS found for that PVS on varserver")
+            return
+
+        # setup a periodic task to fetch data every 5 seconds
+        pvs_data = PVSData()
+        while True:
+            await ess_updater.update(pvs_data)
+
+            print(">>>>>> ESS:")
+            for ess in pvs_data.ess.values():
+                print(f"{ess.serial_number}: {ess}")
+
+            await asyncio.sleep(5)
+
+if __name__ == "__main__":
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        print("Exiting...")