Developing pyupgw

This section gives an overview of developing support for new devices compatible with Unisenza Plus, or supporting new features for the existing devices.

Logging messages

The easiest way to inspect messages that the client exchanges with the cloud service is logging. The command-line interface supports YAML configurations in Python logging configuration schema. The following sample configuration produces both nicely formatted output into the console, and structured logs in JSON lines into a file.

version: 1
formatters:
  file:
    class: jsonformatter.JsonFormatter
    format:
      asctime: asctime
      levelname: levelname
      name: name
      message: message
      request: request
      response: response
handlers:
  console:
    class: rich.logging.RichHandler
  file:
    class: logging.FileHandler
    formatter: file
    filename: pyupgw.log
loggers:
  pyupgw.client:
    handlers:
      - console
      - file
    level: DEBUG
  pyupgw.cli:
    handlers:
      - console
    level: INFO

The CLI can then be run with the configuration file provided as an option:

$ pyupgw --logging-config=my-config.yaml

The requests and responses to and from the server are logged:

• As repr() of the object in the log message

• Structured JSON in request and response fields, respectively

The latter format is useful for offline inspection the objects with Python scripts.