Skip to main content

Assorted utility functions for working with data downloaded from Selectronics' SP-LINK programme which communicates with their solar inverter controllers.

Project description

Assorted utility functions for working with data downloaded from Selectronics' SP-LINK programme which communicates with their solar inverter controllers.

Latest release 20220918:

  • SPLinkData.plot: rename key_specs keyword parameter to mandatory posiitional data_specs parameter.
  • SPLinkData.resolve: accept multiple specification strings.
  • New SPLinkData.plot_data_from_spec(start,stop,data_spec,...) method to return a list of PlotSeries instances.
  • SPLinkData.plot: drop mode param (unused).
  • SPLinkData.plot: process plot data and annotate with style, call Axes.plot or Axes.stackplot instead of DataFrame.plot.
  • SPLinkData.plot: axes() now has a better default size, drop our own default size.
  • SPLinkData.plot: new optional ax_title parameter to specify a title for the axes.
  • SPLinkCommand.cmd_plot: make pseudo-data "POWER" the default and special case a stack plot for "POWER".

I use this to gather and plot data from my solar inverter.

Function main(argv=None)

SP-Link command line mode.

Class SPLinkCommand(cs.timeseries.TimeSeriesBaseCommand, cs.cmdutils.BaseCommand)

Command line to work with SP-Link data downloads.

Command line usage:

Usage: splink [-d spdpath] [-n] subcommand...
    -d spdpath  Specify the directory containing the SP-Link downloads
                and time series. Default from $SPLINK_DATADIR,
                or '.'.
    -n          No action; recite planned actions.
  Subcommands:
    export dataset
      Export the named dataset in the original CSV form.
      Available datasets: DailySummaryData DetailedData
    fetch [-F rsync-source] [-nx] [-- [rsync-options...]]
      Rsync everything from rsync-source into the downloads area.
      -F    Fetch rsync source, default from $SPLINK_FETCH_SOURCE.
      -n    Passed to rsync. Just more convenient than putting it at the end.
      -x    Delete source files.
    help [-l] [subcommand-names...]
      Print the full help for the named subcommands,
      or for all subcommands if no names are specified.
      -l  Long help even if no subcommand-names provided.
    import [-d dataset,...] [-n] [sp-link-download...]
      Import CSV data from the downloads area into the time series data.
      -d datasets       Comma separated list of datasets to import.
                        Default datasets: DailySummaryData DetailedData EventData
      -f                Force. Import datasets even if already marked as
                        imported.
      -n                No action. Recite planned imports.
      sp-link-download  Specify specific individual downloads to import.
                        The default is any download not tagged as already
                        imported.
    info
      Report infomation about the time series stored at tspath.
    plot [-e event,...] [-f] [-o imagepath] [--show] start-time [stop-time] {mode|[dataset:]{glob|field}}...
      Plot the data from specified fields for the specified time range.
      Options:
        --bare          Strip axes and padding from the plot.
        -e events,...   Display the specified events.
        -f              Force. Overwirte the image path even if it exists.
        --stacked       Stack graphed values on top of each other.
        -o imagepath    Write the plot to imagepath.
                        If not specified, the image will be written
                        to the standard output in sixel format if
                        it is a terminal, and in PNG format otherwise.
        --show          Open the image path with "open".
        --tz tzspec     Skew the UTC times presented on the graph
                        to emulate the timezone specified by tzspec.
                        The default skew is the system local timezone.
        start-time      An integer number of days before the current time
                        or any datetime specification recognised by
                        dateutil.parser.parse.
        stop-time       Optional stop time, default now.
                        An integer number of days before the current time
                        or any datetime specification recognised by
                        dateutil.parser.parse.
        mode            A named graph mode, implying a group of fields.
    pull [-d dataset,...] [-F rsync-source] [-nx]
      Fetch and import data.
      -d dataset,...
            Specify the datasets to import.
      -F    Fetch rsync source, default from $SPLINK_FETCH_SOURCE.
      -n    No action; pass -n to rsync. Just more convenient than putting it at the end.
      -x    Delete source files.

Class SPLinkCSVDir(cs.fs.HasFSPath)

A class for working with SP-Link data downloads, referring to a particular PerformanceData* download directory.

Class SPLinkData(cs.fs.HasFSPath, cs.resources.MultiOpenMixin, cs.context.ContextManagerMixin)

A directory containing SP-LInk data.

This contains:

  • downloads: a directory containing copies of various SP-Link downloads i.e. this contains directories named PerformanceData_*.
  • events.db: accrued event data from the EventData CSV files
  • DailySummaryData: an SPLinkDataDir containing accrued data from the DailySummaryData CSV files
  • DetailedData: an SPLinkDataDir containing accrued data from the DetailedData CSV files

Class SPLinkDataDir(cs.timeseries.TimeSeriesDataDir, cs.timeseries.TimeSeriesMapping, builtins.dict, cs.resources.MultiOpenMixin, cs.context.ContextManagerMixin, cs.fs.HasFSPath, cs.configutils.HasConfigIni, cs.timeseries.HasEpochMixin, cs.timeseries.TimeStepsMixin)

A TimeSeriesDataDir to hold log data from an SP-Link CSV data download. This holds the data from a particular CSV log such as 'DetailedData'. The SPLinkData class manages a couple of these and a downloads subdirectory and an events SQLTags.

Method SPLinkDataDir.__init__(self, dirpath, dataset: str, step: int, policy=None, **kw): Initialise the SPLinkDataDir.

Parameters:

  • dirpath: the pathname of the directory holding the downloaded CSV files
  • dataset: which CSV file populates this time series, eg 'DetailedData'
  • step: optional time series step size, default SPLinkDataDir.DEFAULT_LOG_FREQUENCY, which comes from SPLinkCSVDir.DEFAULT_LOG_FREQUENCY
  • policy: optional TimespanPolicyinstance; if omitted anTimespanPolicyYearlyinstance will be made Other keyword arguments are passed to theTimeSeriesDataDir` initialiser.

Class SPLinkDataFileInfo(builtins.tuple)

SPLinkDataFileInfo(fspath, sitename, dataset, unixtime, dotext)

Method SPLinkDataFileInfo.__new__(_cls, fspath, sitename, dataset, unixtime, dotext): Create new instance of SPLinkDataFileInfo(fspath, sitename, dataset, unixtime, dotext)

Function ts2001_unixtime(tzname=None)

Convert an SP-Link seconds-since-2001-01-01-local-time offset into a UNIX time.

Release Log

Release 20220918:

  • SPLinkData.plot: rename key_specs keyword parameter to mandatory posiitional data_specs parameter.
  • SPLinkData.resolve: accept multiple specification strings.
  • New SPLinkData.plot_data_from_spec(start,stop,data_spec,...) method to return a list of PlotSeries instances.
  • SPLinkData.plot: drop mode param (unused).
  • SPLinkData.plot: process plot data and annotate with style, call Axes.plot or Axes.stackplot instead of DataFrame.plot.
  • SPLinkData.plot: axes() now has a better default size, drop our own default size.
  • SPLinkData.plot: new optional ax_title parameter to specify a title for the axes.
  • SPLinkCommand.cmd_plot: make pseudo-data "POWER" the default and special case a stack plot for "POWER".

Release 20220806: Faster events prescan during import (it appears that timestamps are unique), less import noise.

Release 20220805:

  • SPLinkCommand.cmd_plot: new --bare option to strip legends, axes etc from a graph.
  • Assorted small internal changes.

Release 20220626:

  • Lots of updates to the import process.
  • SPLinkCommand: new cmd_pull, combining fetch and import.
  • SPLinkData.plot: rework the key matching and plot data gathering, pass the utcoffset to the subsidiary timeseries plot call.
  • SPLinkDataDir.to_csv: shim TimeSeriesDataDir,to_csv to reproduce the SP-Link download CSV format.
  • SPLinkCommand.cmd_export: new "splink export" command to export data in SP-Link CSV format.
  • Many minor updates.

Release 20220606: Initial PyPI release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cs.splink-20220918.tar.gz (18.6 kB view hashes)

Uploaded Source

Built Distribution

cs.splink-20220918-py3-none-any.whl (15.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page