add capability to restrict remote panel modes

.drone.yml

@@ -0,0 +1,202 @@
+kind: pipeline
+type: docker
+name: ci
+
+trigger:
+  event:
+    - pull_request
+    - push
+    - tag
+
+steps:
+  # - name: lint
+  #   image: cache.coadcorp.com/library/golang:1.26
+  #   environment:
+  #     GOFLAGS: -mod=mod
+  #     GOBIN: /usr/local/bin
+  #   commands:
+  #     - go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.64.8
+  #     - golangci-lint version
+  #     - golangci-lint run --timeout=5m
+
+  # - name: test
+  #   image: cache.coadcorp.com/library/golang:1.26
+  #   environment:
+  #     GOFLAGS: -mod=mod
+  #   commands:
+  #     - go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...
+
+  - name: build
+    image: cache.coadcorp.com/library/golang:1.26
+    environment:
+      GOFLAGS: -mod=mod
+    commands:
+      - CGO_ENABLED=0 go build -v ./cmd/invertergui
+
+  - name: build-linux-binaries
+    image: cache.coadcorp.com/library/golang:1.26
+    environment:
+      GOFLAGS: -mod=mod
+    commands:
+      - mkdir -p dist
+      - CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -v -o dist/invertergui-linux-amd64 ./cmd/invertergui
+      - CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -v -o dist/invertergui-linux-arm64 ./cmd/invertergui
+    when:
+      event:
+        - push
+        - tag
+
+  - name: docker-build-validate
+    image: gcr.io/kaniko-project/executor:v1.24.0
+    commands:
+      - /kaniko/executor --context "${DRONE_WORKSPACE}" --dockerfile "${DRONE_WORKSPACE}/Dockerfile" --no-push --destination registry.coadcorp.com/nathan/invertergui:pr-${DRONE_BUILD_NUMBER}
+    when:
+      event:
+        - pull_request
+
+  - name: docker-publish-commit-amd64
+    image: plugins/docker
+    settings:
+      registry: registry.coadcorp.com
+      repo: "registry.coadcorp.com/nathan/invertergui"
+      dockerfile: Dockerfile.publish.amd64
+      username: nathan
+      password:
+        from_secret: registry_password
+      tags:
+        - "${DRONE_COMMIT_SHA}-linux-amd64"
+    when:
+      event:
+        - push
+
+  - name: docker-publish-commit-arm64
+    image: plugins/docker
+    settings:
+      registry: registry.coadcorp.com
+      repo: "registry.coadcorp.com/nathan/invertergui"
+      dockerfile: Dockerfile.publish.arm64
+      username: nathan
+      password:
+        from_secret: registry_password
+      tags:
+        - "${DRONE_COMMIT_SHA}-linux-arm64"
+    when:
+      event:
+        - push
+
+  - name: docker-manifest-commit
+    image: plugins/manifest
+    settings:
+      registry: registry.coadcorp.com
+      username: nathan
+      password:
+        from_secret: registry_password
+      target: "registry.coadcorp.com/nathan/invertergui:${DRONE_COMMIT_SHA}"
+      template: "registry.coadcorp.com/nathan/invertergui:${DRONE_COMMIT_SHA}-OS-ARCH"
+      platforms:
+        - "linux/amd64"
+        - "linux/arm64"
+    when:
+      event:
+        - push
+
+  - name: docker-publish-latest-amd64
+    image: plugins/docker
+    settings:
+      registry: registry.coadcorp.com
+      repo: "registry.coadcorp.com/nathan/invertergui"
+      dockerfile: Dockerfile.publish.amd64
+      username: nathan
+      password:
+        from_secret: registry_password
+      tags:
+        - "latest-linux-amd64"
+    when:
+      event:
+        - push
+      branch:
+        - main
+        - master
+
+  - name: docker-publish-latest-arm64
+    image: plugins/docker
+    settings:
+      registry: registry.coadcorp.com
+      repo: "registry.coadcorp.com/nathan/invertergui"
+      dockerfile: Dockerfile.publish.arm64
+      username: nathan
+      password:
+        from_secret: registry_password
+      tags:
+        - "latest-linux-arm64"
+    when:
+      event:
+        - push
+      branch:
+        - main
+        - master
+
+  - name: docker-manifest-latest
+    image: plugins/manifest
+    settings:
+      registry: registry.coadcorp.com
+      username: nathan
+      password:
+        from_secret: registry_password
+      target: "registry.coadcorp.com/nathan/invertergui:latest"
+      template: "registry.coadcorp.com/nathan/invertergui:latest-OS-ARCH"
+      platforms:
+        - "linux/amd64"
+        - "linux/arm64"
+    when:
+      event:
+        - push
+      branch:
+        - main
+        - master
+
+  - name: docker-publish-release-amd64
+    image: plugins/docker
+    settings:
+      registry: registry.coadcorp.com
+      repo: "registry.coadcorp.com/nathan/invertergui"
+      dockerfile: Dockerfile.publish.amd64
+      username: nathan
+      password:
+        from_secret: registry_password
+      tags:
+        - "${DRONE_TAG}-linux-amd64"
+    when:
+      event:
+        - tag
+
+  - name: docker-publish-release-arm64
+    image: plugins/docker
+    settings:
+      registry: registry.coadcorp.com
+      repo: "registry.coadcorp.com/nathan/invertergui"
+      dockerfile: Dockerfile.publish.arm64
+      username: nathan
+      password:
+        from_secret: registry_password
+      tags:
+        - "${DRONE_TAG}-linux-arm64"
+    when:
+      event:
+        - tag
+
+  - name: docker-manifest-release
+    image: plugins/manifest
+    settings:
+      registry: registry.coadcorp.com
+      username: nathan
+      password:
+        from_secret: registry_password
+      target: "registry.coadcorp.com/nathan/invertergui:${DRONE_TAG}"
+      template: "registry.coadcorp.com/nathan/invertergui:${DRONE_TAG}-OS-ARCH"
+      platforms:
+        - "linux/amd64"
+        - "linux/arm64"
+    when:
+      event:
+        - tag

.github/workflows/docker-build.yml

@@ -1,65 +0,0 @@
-# Tagging based on: https://docs.docker.com/build/ci/github-actions/manage-tags-labels/
-# Multi platform based on: https://docs.docker.com/build/ci/github-actions/multi-platform/
-name: build
-on:
-  push:
-    branches:
-      - "**"
-    tags:
-      - "v*"
-  pull_request:
-
-jobs:
-  inverter_gui_pipeline:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: "Setup"
-        uses: actions/setup-go@v3
-        with:
-          go-version: '1.22'
-
-      - name: Lint
-        uses: golangci/golangci-lint-action@v3
-        with:
-          version: latest
-
-      - name: Test
-        run: go test -v -race -coverprofile=coverage.txt -covermode=atomic  ./...
-
-      - name: Upload code coverage
-        uses: codecov/codecov-action@v3
-
-      - name: Generate docker image labels and tags
-        id: docker_meta
-        uses: docker/metadata-action@v4
-        with:
-          images: ghcr.io/diebietse/invertergui
-          tags: |
-            type=ref,event=branch
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-
-      - name: Login to GitHub Container Registry
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build and push to GitHub Container Registry
-        uses: docker/build-push-action@v4
-        with:
-          platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.docker_meta.outputs.tags }}
-          labels: ${{ steps.docker_meta.outputs.labels }}

.gitignore

@@ -23,4 +23,8 @@ _testmain.go
 *.test
 *.prof
 
-vendor/
+vendor/
+
+# Python cache files (for Home Assistant custom component)
+__pycache__/
+*.pyc

Dockerfile

@@ -1,14 +1,24 @@
-FROM golang:1.22-alpine as builder
+ARG BUILDPLATFORM=linux/amd64
+FROM --platform=${BUILDPLATFORM} golang:1.26-alpine as builder
+
+ARG TARGETOS=linux
+ARG TARGETARCH=amd64
+ARG TARGETVARIANT
 
 RUN mkdir /build
 COPY . /build/
 WORKDIR /build
-RUN CGO_ENABLED=0 go build -o invertergui ./cmd/invertergui
+RUN set -eux; \
+    GOARM=""; \
+    if [ "${TARGETARCH}" = "arm" ] && [ -n "${TARGETVARIANT:-}" ]; then GOARM="${TARGETVARIANT#v}"; fi; \
+    CGO_ENABLED=0 GOOS="${TARGETOS}" GOARCH="${TARGETARCH}" GOARM="${GOARM}" go build -o invertergui ./cmd/invertergui
 
 FROM scratch
 
 # Group ID 20 is dialout, needed for tty read/write access
 USER 3000:20
+ENV READ_ONLY=false
+ENV CONTROL_ALLOWED_PANEL_MODES=""
 COPY --from=builder /build/invertergui /bin/
 ENTRYPOINT [ "/bin/invertergui" ]
 EXPOSE 8080

Dockerfile.publish.amd64

@@ -0,0 +1,9 @@
+FROM scratch
+
+# Group ID 20 is dialout, needed for tty read/write access
+USER 3000:20
+ENV READ_ONLY=false
+ENV CONTROL_ALLOWED_PANEL_MODES=""
+COPY dist/invertergui-linux-amd64 /bin/invertergui
+ENTRYPOINT ["/bin/invertergui"]
+EXPOSE 8080

Dockerfile.publish.arm64

@@ -0,0 +1,9 @@
+FROM scratch
+
+# Group ID 20 is dialout, needed for tty read/write access
+USER 3000:20
+ENV READ_ONLY=false
+ENV CONTROL_ALLOWED_PANEL_MODES=""
+COPY dist/invertergui-linux-arm64 /bin/invertergui
+ENTRYPOINT ["/bin/invertergui"]
+EXPOSE 8080

README.md

@@ -1,28 +1,84 @@
 # Inverter GUI
 
-[![release][release-badge]][release-link]
+[Repository](https://git.coadcorp.com/nathan/invertergui) | [Container Image](https://registry.coadcorp.com/nathan/invertergui)
-[![publish-docker-image][publish-docker-badge]][publish-docker-link]
-![license][license-link]
-[![codecov][codecov-badge]][codecov-link]
 
 The invertergui allows the monitoring of a [Victron Multiplus](https://www.victronenergy.com/inverters-chargers/multiplus-12v-24v-48v-800va-3kva) via the [MK3/MK2 USB](https://www.victronenergy.com/accessories/interface-mk3-usb) or the MK2 RS232.
 
-The [`ghcr.io/diebietse/invertergui`](https://github.com/orgs/diebietse/packages/container/package/invertergui) docker image is a build of this repository.
+The [`registry.coadcorp.com/nathan/invertergui`](https://registry.coadcorp.com/nathan/invertergui) container image is a build of this repository.
+
+The code has been updated to support more of the protocol published by Victron at https://www.victronenergy.com/upload/documents/Technical-Information-Interfacing-with-VE-Bus-products-MK2-Protocol-3-14.pdf 
+
+## Acknowledgements
+
+This project is based on the original open source `invertergui` project by Hendrik van Wyk and contributors:
+
+- Original repository: https://github.com/diebietse/invertergui
+- Home Assistant `victron-mk3-hass` inspiration: https://github.com/j9brown/victron-mk3-hass
 
 ## Demo
 
-![demo](https://rawcdn.githack.com/diebietse/invertergui/c856c451cd5c926b588914583bc4ab1498b7da99/invertergui_demo.gif "Invertergui Demo")
+![demo](./invertergui_demo.gif "Invertergui Demo")
 
 ## Quick Start
 
 ```console
-docker run --name invertergui --device /dev/ttyUSB0:/dev/ttyUSB0 -p 8080:8080 ghcr.io/diebietse/invertergui
+docker run --name invertergui --device /dev/ttyUSB0:/dev/ttyUSB0 -p 8080:8080 registry.coadcorp.com/nathan/invertergui:latest
 ```
 
 ## Requirements
 
 This project makes use of [Go Modules](https://github.com/golang/go/wiki/Modules). The minimum supported version for Go is 1.22
 
+## Driver API: Metadata + Safe Transactions
+
+The MK2 driver now includes a metadata and transaction safety layer via the
+`mk2driver.MetadataControl` interface:
+
+- Register metadata lookup (`RegisterMetadata`, `ListRegisterMetadata`)
+- Generic register reads by kind/id (`ReadRegister`)
+- Transactional writes with retry and verify (`WriteRegister`)
+
+`WriteRegister` supports:
+
+- `ReadBeforeWrite`
+- `VerifyAfterWrite`
+- configurable retry count and delay
+
+This layer is additive and does not replace existing `WriteSetting`, `WriteRAMVar`,
+or panel control APIs.
+
+## Advanced Control + Orchestration Features
+
+The codebase now includes:
+
+- Full MK2 command-path coverage in driver APIs for:
+  - `0x0E` device state read/write
+  - register read by id (`0x30`, `0x31`)
+  - selected read/write flows (`0x32`, `0x33`, `0x34`, `0x35`)
+  - RAM var metadata/info (`0x36`)
+  - write-by-id flows (`0x37`, `0x38`)
+- Register metadata with `unit`, `min/max`, `scale`, `writable`, and `safety_class`.
+- Transaction-safe writes with read-before-write, verify-after-write, retry/backoff, and timeout classes.
+- Snapshot/diff/restore register workflows with rollback on partial restore failure.
+- Alarm engine with LED/state alarms + command-failure alarms, including debounce and clear behavior.
+- Venus-like derived operating state model: `Off`, `Inverter`, `Charger`, `Passthru`, `Fault`.
+- Historical counters for energy and availability:
+  - `energy_in_wh`, `energy_out_wh`
+  - battery charge/discharge Wh
+  - uptime seconds
+  - fault count + last fault timestamp
+- Multi-device orchestration fields and topics:
+  - `device_id`, `instance_id`, `phase`, `phase_group`
+  - per-device topics and phase-group fanout topics
+- Command arbitration/policy layer:
+  - single serialized write path
+  - lockout windows
+  - source tagging (`ui`, `mqtt`, `automation`)
+  - max current guardrail + mode rate limit + maintenance/read-only profiles
+- Venus-compatible MQTT mode (`N/...` + optional `W/...`) for HA/Node-RED/VRM-style workflows.
+- Guide-style Victron ESS MQTT paths (`settings/0/Settings/CGwacs/*`) with `victron/N/...` and `victron/W/...` prefix compatibility.
+- Structured diagnostics bundle topics with protocol traces, recent command history, and health score.
+
 ## Getting started
 
 ```bash
@@ -31,6 +87,7 @@ Usage:
 
 Application Options:
       --address=        The IP/DNS and port of the machine that the application is running on. (default: :8080) [$ADDRESS]
+      --read_only       Disable all write operations and run in monitoring-only mode. [$READ_ONLY]
       --data.source=    Set the source of data for the inverter gui. "serial", "tcp" or "mock" (default: serial) [$DATA_SOURCE]
       --data.host=      Host to connect when source is set to tcp. (default: localhost:8139) [$DATA_HOST]
       --data.device=    TTY device to use when source is set to serial. (default: /dev/ttyUSB0) [$DATA_DEVICE]
@@ -41,19 +98,98 @@ Application Options:
       --mqtt.topic=     Set the MQTT topic updates published to. (default: invertergui/updates) [$MQTT_TOPIC]
       --mqtt.command_topic= Set the MQTT topic that receives write commands for Victron settings/RAM variables. (default: invertergui/settings/set) [$MQTT_COMMAND_TOPIC]
       --mqtt.status_topic=  Set the MQTT topic where write command status updates are published. (default: invertergui/settings/status) [$MQTT_STATUS_TOPIC]
+      --mqtt.device_id= Set logical device ID used for per-device orchestration topics. (default: invertergui) [$MQTT_DEVICE_ID]
+      --mqtt.history_size= Number of samples retained for rolling history summaries. (default: 120) [$MQTT_HISTORY_SIZE]
+      --mqtt.instance_id= Device instance ID for multi-device orchestration and Venus compatibility. (default: 0) [$MQTT_INSTANCE_ID]
+      --mqtt.phase=    Electrical phase label for this instance (L1/L2/L3). (default: L1) [$MQTT_PHASE]
+      --mqtt.phase_group= Grouping key for parallel/3-phase system aggregation topics. (default: default) [$MQTT_PHASE_GROUP]
       --mqtt.ha.enabled Enable Home Assistant MQTT discovery integration. [$MQTT_HA_ENABLED]
       --mqtt.ha.discovery_prefix= Set Home Assistant MQTT discovery prefix. (default: homeassistant) [$MQTT_HA_DISCOVERY_PREFIX]
       --mqtt.ha.node_id= Set Home Assistant node ID used for discovery topics and unique IDs. (default: invertergui) [$MQTT_HA_NODE_ID]
       --mqtt.ha.device_name= Set Home Assistant device display name. (default: Victron Inverter) [$MQTT_HA_DEVICE_NAME]
+      --mqtt.venus.enabled Enable Venus-style MQTT compatibility topics (N/W model). [$MQTT_VENUS_ENABLED]
+      --mqtt.venus.portal_id= Set Venus portal ID segment used in N/W topics. (default: invertergui) [$MQTT_VENUS_PORTAL_ID]
+      --mqtt.venus.service= Set Venus service segment used in N/W topics. (default: vebus/257) [$MQTT_VENUS_SERVICE]
+      --mqtt.venus.subscribe_writes Subscribe to Venus W/... topics and map to MK2 commands. [$MQTT_VENUS_SUBSCRIBE_WRITES]
+      --mqtt.venus.topic_prefix= Optional topic prefix before Venus N/W topics, e.g. victron. [$MQTT_VENUS_TOPIC_PREFIX]
+      --mqtt.venus.guide_compat Enable guide-style settings/0/Settings/CGwacs compatibility paths. [$MQTT_VENUS_GUIDE_COMPAT]
       --mqtt.username=  Set the MQTT username [$MQTT_USERNAME]
       --mqtt.password=  Set the MQTT password [$MQTT_PASSWORD]
       --mqtt.password-file= Path to a file containing the MQTT password [$MQTT_PASSWORD_FILE]
+      --control.profile= Write policy profile: normal, maintenance, or read_only. (default: normal) [$CONTROL_PROFILE]
+      --control.max_current_limit= Optional max AC current limit guardrail in amps (0 disables). (default: 0) [$CONTROL_MAX_CURRENT_LIMIT]
+      --control.mode_change_min_interval= Minimum time between mode changes. (default: 3s) [$CONTROL_MODE_CHANGE_MIN_INTERVAL]
+      --control.lockout_window= Post-command lockout window for command arbitration. (default: 0s) [$CONTROL_LOCKOUT_WINDOW]
+      --control.allowed_panel_modes= Comma-separated allowlist of remote panel modes. Supported values: on, off, charger_only, inverter_only. Empty allows all modes. [$CONTROL_ALLOWED_PANEL_MODES]
       --loglevel=       The log level to generate logs at. ("panic", "fatal", "error", "warn", "info", "debug", "trace") (default: info) [$LOGLEVEL]
 
 Help Options:
   -h, --help            Show this help message
 ```
 
+### Read-Only Mode
+
+Set `READ_ONLY=true` (or `--read_only`) to disable all write operations.
+When read-only mode is enabled, the app still monitors and publishes telemetry, but it will not send commands to the Victron device.
+
+This affects:
+
+- MQTT command handling (`--mqtt.command_topic` commands are ignored)
+- Web UI control actions (`POST /api/remote-panel/state` and `POST /api/remote-panel/standby`)
+
+### Remote Panel Mode Allowlist
+
+Set `CONTROL_ALLOWED_PANEL_MODES` (or `--control.allowed_panel_modes`) to restrict which
+remote panel modes can be selected from Web UI, MQTT, Home Assistant, and Venus-compatible
+write paths.
+
+Supported values:
+
+- `on`
+- `off`
+- `charger_only`
+- `inverter_only`
+
+Use a comma-separated list. Empty means all modes are allowed.
+
+Example:
+
+- `CONTROL_ALLOWED_PANEL_MODES=off,charger_only`
+
+Example `docker-compose.yml` snippet:
+
+```yaml
+services:
+  invertergui:
+    image: registry.coadcorp.com/nathan/invertergui:latest
+    environment:
+      READ_ONLY: "true"
+      CONTROL_ALLOWED_PANEL_MODES: "off,charger_only"
+    devices:
+      - "/dev/ttyUSB0:/dev/ttyUSB0"
+    command: ["--mqtt.enabled", "--mqtt.broker=tcp://192.168.1.1:1883", "--loglevel=info"]      
+```
+
+### Home Assistant Guide-Style ESS Control
+
+To mimic the Victron community ESS control approach (MQTT `N/...` state + `W/...` writes under `settings/0/Settings/CGwacs/...`):
+
+1. Start invertergui with:
+   - `MQTT_VENUS_ENABLED=true`
+   - `MQTT_VENUS_GUIDE_COMPAT=true`
+   - `MQTT_VENUS_TOPIC_PREFIX=victron`
+   - `MQTT_VENUS_PORTAL_ID=invertergui` (or your chosen portal id)
+2. In Home Assistant:
+   - Use the included custom integration (`custom_components/victron_mk2_mqtt`) which now exposes ESS-style entities and service calls.
+   - Or use `homeassistant/packages/invertergui_mqtt.yaml`, which includes guide-style MQTT entities:
+     - `number.victron_ess_grid_setpoint`
+     - `number.victron_ess_max_charge_power`
+     - `number.victron_ess_max_discharge_power`
+     - `switch.victron_ess_optimized_mode`
+
+Compatibility note:
+- MK2/VE.Bus does not expose every Venus ESS feature one-to-one. This project maps ESS-style commands onto available MK2 controls (mode/current-limit/policy-safe behavior) to provide similar Home Assistant control flow.
+
 ## Port 8080
 
 The default HTTP server port is hosted on port 8080. This exposes the HTTP server that hosts the:
@@ -306,15 +442,27 @@ The MQTT client will publish updates to the given broker at the set topic.
 --mqtt.topic=     Set the MQTT topic updates published to. (default: invertergui/updates) [$MQTT_TOPIC]
 --mqtt.command_topic= Set the MQTT topic that receives write commands for Victron settings/RAM variables. (default: invertergui/settings/set) [$MQTT_COMMAND_TOPIC]
 --mqtt.status_topic=  Set the MQTT topic where write command status updates are published. (default: invertergui/settings/status) [$MQTT_STATUS_TOPIC]
+--mqtt.device_id= Set logical device ID used for per-device orchestration topics. (default: invertergui) [$MQTT_DEVICE_ID]
+--mqtt.history_size= Number of samples retained for rolling history summaries. (default: 120) [$MQTT_HISTORY_SIZE]
 --mqtt.ha.enabled Enable Home Assistant MQTT discovery integration. [$MQTT_HA_ENABLED]
 --mqtt.ha.discovery_prefix= Set Home Assistant MQTT discovery prefix. (default: homeassistant) [$MQTT_HA_DISCOVERY_PREFIX]
 --mqtt.ha.node_id= Set Home Assistant node ID used for discovery topics and unique IDs. (default: invertergui) [$MQTT_HA_NODE_ID]
 --mqtt.ha.device_name= Set Home Assistant device display name. (default: Victron Inverter) [$MQTT_HA_DEVICE_NAME]
+--mqtt.venus.enabled Enable Venus-style MQTT compatibility topics (N/W model). [$MQTT_VENUS_ENABLED]
+--mqtt.venus.portal_id= Set Venus portal ID segment used in N/W topics. (default: invertergui) [$MQTT_VENUS_PORTAL_ID]
+--mqtt.venus.service= Set Venus service segment used in N/W topics. (default: vebus/257) [$MQTT_VENUS_SERVICE]
+--mqtt.venus.subscribe_writes Subscribe to Venus W/... topics and map to MK2 commands. [$MQTT_VENUS_SUBSCRIBE_WRITES]
 --mqtt.username=  Set the MQTT username [$MQTT_USERNAME]
 --mqtt.password=  Set the MQTT password [$MQTT_PASSWORD]
 --mqtt.password-file= Path to a file containing the MQTT password [$MQTT_PASSWORD_FILE]
 ```
 
+Related global option:
+
+```bash
+--read_only Disable all write operations and run in monitoring-only mode. [$READ_ONLY]
+```
+
 The MQTT client can be enabled by setting the environment variable `MQTT_ENABLED=true` or flag `--mqtt.enabled`.
 All MQTT configuration can be done via flags or as environment variables.
 The URI for the broker can be configured format should be `scheme://host:port`, where "scheme" is one of "tcp", "ssl", or "ws".
@@ -366,6 +514,60 @@ Low-level writes are still supported:
 `kind` supports `panel_state`, `setting`, and `ram_var` (with aliases for each).  
 The result is published to `--mqtt.status_topic` with status `ok` or `error`.
 
+### MQTT Device Orchestration Topics
+
+For multi-device deployments on one MQTT broker, `invertergui` now also publishes
+device-scoped orchestration topics under:
+
+- `{topic-root}/devices/{device_id}/state`
+- `{topic-root}/devices/{device_id}/history/summary`
+- `{topic-root}/devices/{device_id}/alarms/active`
+
+Set `--mqtt.device_id` (or `MQTT_DEVICE_ID`) per inverter instance so each instance
+publishes to a unique device path.
+
+Rolling history depth for the summary window is set by `--mqtt.history_size`.
+
+### Venus-Style MQTT Compatibility
+
+Enable Venus-compatible topics with:
+
+```bash
+--mqtt.venus.enabled
+```
+
+When enabled, `invertergui` publishes Venus-style notifications to:
+
+- `N/{portal_id}/{service}/...`
+
+Defaults:
+
+- `portal_id`: `invertergui` (`--mqtt.venus.portal_id`)
+- `service`: `vebus/257` (`--mqtt.venus.service`)
+
+Published paths include common VE.Bus style values such as:
+
+- `Dc/0/Voltage`, `Dc/0/Current`, `Dc/0/Power`, `Soc`
+- `Ac/ActiveIn/L1/V`, `Ac/ActiveIn/L1/I`, `Ac/ActiveIn/L1/F`, `Ac/ActiveIn/L1/P`
+- `Ac/Out/L1/V`, `Ac/Out/L1/I`, `Ac/Out/L1/F`, `Ac/Out/L1/P`
+- alarm paths (`Alarms/LowBattery`, `Alarms/HighTemperature`, `Alarms/Overload`, `Alarms/Communication`)
+
+Optional write compatibility can be enabled with:
+
+```bash
+--mqtt.venus.subscribe_writes
+```
+
+This subscribes to:
+
+- `W/{portal_id}/{service}/#`
+
+and maps supported write paths to MK2 control operations:
+
+- `Mode` -> remote panel mode
+- `Ac/ActiveIn/CurrentLimit` -> remote panel current limit
+- `Settings/Standby` / `RemotePanel/Standby` -> standby control
+
 ### Home Assistant
 
 Enable Home Assistant auto-discovery with:
@@ -393,6 +595,119 @@ plus remote panel controls for:
 The combined mode + current limit behavior is provided through the `panel_state` MQTT command kind,
 which mirrors `victron_mk3.set_remote_panel_state`.
 
+### Home Assistant Custom Component (MQTT)
+
+This repository also includes a custom Home Assistant integration at:
+
+- `custom_components/victron_mk2_mqtt`
+
+This component is useful if you want HA entities/services that are explicitly tied to
+`invertergui` MQTT topics, instead of relying only on MQTT auto-discovery entities.
+
+If you use this custom component, you can disable `--mqtt.ha.enabled` in `invertergui`
+to avoid duplicate entities created by MQTT discovery.
+
+Install via HACS:
+
+1. Add the integration repository in Home Assistant:
+   [![Open your Home Assistant instance and open this repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=nathan&repository=invertergui&category=integration)
+2. Install `Victron MK2 MQTT` from HACS.
+3. Restart Home Assistant.
+4. Add the YAML configuration shown below.
+
+If you are not mirroring this repo to GitHub, use the manual install method below.
+
+Manual install (alternative):
+
+```text
+<home-assistant-config>/custom_components/victron_mk2_mqtt
+```
+
+Then add YAML config:
+
+```yaml
+victron_mk2_mqtt:
+  name: Victron Inverter
+  state_topic: invertergui/updates
+  command_topic: invertergui/settings/set
+  status_topic: invertergui/settings/status
+  # topic_root is optional; defaults to state_topic root (for example "invertergui")
+  # topic_root: invertergui
+```
+
+Provided entities include:
+
+- Telemetry sensors (battery/input/output voltage/current/frequency and derived power)
+- `Remote Panel Mode` (`charger_only`, `inverter_only`, `on`, `off`)
+- `Remote Panel Current Limit` (A)
+- `Remote Panel Standby`
+- Diagnostic entities (`Data Valid`, `Last Command Error`)
+
+Service exposed by the integration:
+
+- `victron_mk2_mqtt.set_remote_panel_state`
+
+Example service call:
+
+```yaml
+service: victron_mk2_mqtt.set_remote_panel_state
+data:
+  mode: on
+  current_limit: 16.0
+```
+
+### Home Assistant MQTT-Only Dashboard (No Duplicate Entities)
+
+If you want the same control/telemetry experience but only via MQTT (without duplicate
+entities from discovery/custom integrations), use the packaged Home Assistant files:
+
+- MQTT entity + control package: `homeassistant/packages/invertergui_mqtt.yaml`
+- Lovelace dashboard: `homeassistant/dashboards/invertergui_mqtt_dashboard.yaml`
+
+The package assumes default topics (`invertergui/updates`, `invertergui/settings/set`,
+`invertergui/settings/status`). If you use custom MQTT topics, update those values in
+`homeassistant/packages/invertergui_mqtt.yaml`.
+
+Recommended for this mode:
+
+- Disable MQTT discovery output from `invertergui` (`--mqtt.ha.enabled=false`)
+- Do not enable the `victron_mk2_mqtt` custom component at the same time
+
+1. Ensure HA packages are enabled (if not already):
+
+```yaml
+homeassistant:
+  packages: !include_dir_named packages
+```
+
+2. Copy package file to your HA config:
+
+```text
+<home-assistant-config>/packages/invertergui_mqtt.yaml
+```
+
+3. Copy dashboard file to your HA config:
+
+```text
+<home-assistant-config>/dashboards/invertergui_mqtt_dashboard.yaml
+```
+
+4. Register the dashboard (YAML mode example):
+
+```yaml
+lovelace:
+  mode: storage
+  dashboards:
+    invertergui-victron:
+      mode: yaml
+      title: Victron MQTT
+      icon: mdi:flash
+      show_in_sidebar: true
+      filename: dashboards/invertergui_mqtt_dashboard.yaml
+```
+
+5. Restart Home Assistant.
+
 ## TTY Device
 
 The intertergui application makes use of a serial tty device to monitor the Multiplus.
@@ -454,12 +769,4 @@ The last four lines are optional, but is useful when debugging and logging conne
 
 This repos includes a [Grafana](https://grafana.com/) dashboard in the [grafana folder](./grafana/prometheus-dashboard.json) that you can import. This is useful if you are using prometheus to log your data and want to display it in a nice way.
 
-![grafana](https://rawcdn.githack.com/diebietse/invertergui/e20f8fb9161758cd12de95d675aee0ed2e044d8e/grafana/dashboard.png "Grafana Dashboard")
+![grafana](./grafana/dashboard.png "Grafana Dashboard")
-
-[publish-docker-badge]: https://github.com/diebietse/invertergui/actions/workflows/docker-build.yml/badge.svg
-[publish-docker-link]: https://github.com/diebietse/invertergui/actions/workflows/docker-build.yml
-[license-link]: https://img.shields.io/github/license/diebietse/invertergui.svg
-[release-badge]: https://img.shields.io/github/v/release/diebietse/invertergui
-[release-link]: https://github.com/diebietse/invertergui/releases
-[codecov-badge]: https://codecov.io/gh/diebietse/invertergui/branch/master/graph/badge.svg?token=xTLfEzoqYF
-[codecov-link]: https://codecov.io/gh/diebietse/invertergui

cmd/invertergui/config.go

@@ -4,13 +4,22 @@ import (
 	"fmt"
 	"os"
 	"strings"
+	"time"
 
 	"github.com/jessevdk/go-flags"
 )
 
 type config struct {
-	Address string `long:"address" env:"ADDRESS" default:":8080" description:"The IP/DNS and port of the machine that the application is running on."`
+	Address  string `long:"address" env:"ADDRESS" default:":8080" description:"The IP/DNS and port of the machine that the application is running on."`
-	Data    struct {
+	ReadOnly bool   `long:"read_only" env:"READ_ONLY" description:"Disable all write operations and run in monitoring-only mode."`
+	Control  struct {
+		Profile               string        `long:"control.profile" env:"CONTROL_PROFILE" default:"normal" description:"Write policy profile: normal, maintenance, or read_only."`
+		MaxCurrentLimit       float64       `long:"control.max_current_limit" env:"CONTROL_MAX_CURRENT_LIMIT" default:"0" description:"Optional max AC current limit guardrail in amps (0 disables)."`
+		ModeChangeMinInterval time.Duration `long:"control.mode_change_min_interval" env:"CONTROL_MODE_CHANGE_MIN_INTERVAL" default:"3s" description:"Minimum time between mode changes."`
+		LockoutWindow         time.Duration `long:"control.lockout_window" env:"CONTROL_LOCKOUT_WINDOW" default:"0s" description:"Post-command lockout window for command arbitration."`
+		AllowedPanelModes     string        `long:"control.allowed_panel_modes" env:"CONTROL_ALLOWED_PANEL_MODES" default:"" description:"Comma-separated allowlist of remote panel modes. Supported values: on, off, charger_only, inverter_only. Empty allows all modes."`
+	}
+	Data struct {
 		Source string `long:"data.source" env:"DATA_SOURCE" default:"serial" description:"Set the source of data for the inverter gui. \"serial\", \"tcp\" or \"mock\""`
 		Host   string `long:"data.host" env:"DATA_HOST" default:"localhost:8139" description:"Host to connect when source is set to tcp."`
 		Device string `long:"data.device" env:"DATA_DEVICE" default:"/dev/ttyUSB0" description:"TTY device to use when source is set to serial."`
@@ -25,12 +34,25 @@ type config struct {
 		Topic        string `long:"mqtt.topic" env:"MQTT_TOPIC" default:"invertergui/updates" description:"Set the MQTT topic updates published to."`
 		CommandTopic string `long:"mqtt.command_topic" env:"MQTT_COMMAND_TOPIC" default:"invertergui/settings/set" description:"Set the MQTT topic that receives write commands for Victron settings/RAM variables."`
 		StatusTopic  string `long:"mqtt.status_topic" env:"MQTT_STATUS_TOPIC" default:"invertergui/settings/status" description:"Set the MQTT topic where write command status updates are published."`
+		DeviceID     string `long:"mqtt.device_id" env:"MQTT_DEVICE_ID" default:"invertergui" description:"Set the logical device ID used for per-device orchestration topics."`
+		HistorySize  int    `long:"mqtt.history_size" env:"MQTT_HISTORY_SIZE" default:"120" description:"Number of telemetry samples retained for rolling history summaries."`
+		InstanceID   int    `long:"mqtt.instance_id" env:"MQTT_INSTANCE_ID" default:"0" description:"Device instance ID for multi-device orchestration and Venus compatibility."`
+		Phase        string `long:"mqtt.phase" env:"MQTT_PHASE" default:"L1" description:"Electrical phase label for this instance (L1/L2/L3)."`
+		PhaseGroup   string `long:"mqtt.phase_group" env:"MQTT_PHASE_GROUP" default:"default" description:"Grouping key for parallel/3-phase system aggregation topics."`
 		HA           struct {
 			Enabled         bool   `long:"mqtt.ha.enabled" env:"MQTT_HA_ENABLED" description:"Enable Home Assistant MQTT discovery integration."`
 			DiscoveryPrefix string `long:"mqtt.ha.discovery_prefix" env:"MQTT_HA_DISCOVERY_PREFIX" default:"homeassistant" description:"Set Home Assistant MQTT discovery prefix."`
 			NodeID          string `long:"mqtt.ha.node_id" env:"MQTT_HA_NODE_ID" default:"invertergui" description:"Set Home Assistant node ID used for discovery topics and unique IDs."`
 			DeviceName      string `long:"mqtt.ha.device_name" env:"MQTT_HA_DEVICE_NAME" default:"Victron Inverter" description:"Set Home Assistant device display name."`
 		}
+		Venus struct {
+			Enabled         bool   `long:"mqtt.venus.enabled" env:"MQTT_VENUS_ENABLED" description:"Enable Venus-style MQTT compatibility topics (N/W topic model)."`
+			PortalID        string `long:"mqtt.venus.portal_id" env:"MQTT_VENUS_PORTAL_ID" default:"invertergui" description:"Set Venus portal ID segment used in N/W topics."`
+			Service         string `long:"mqtt.venus.service" env:"MQTT_VENUS_SERVICE" default:"vebus/257" description:"Set Venus service segment used in N/W topics."`
+			SubscribeWrites bool   `long:"mqtt.venus.subscribe_writes" env:"MQTT_VENUS_SUBSCRIBE_WRITES" description:"Subscribe to Venus write topics and map them to MK2 control commands."`
+			TopicPrefix     string `long:"mqtt.venus.topic_prefix" env:"MQTT_VENUS_TOPIC_PREFIX" default:"" description:"Optional topic prefix before Venus N/W topics, for example 'victron'."`
+			GuideCompat     bool   `long:"mqtt.venus.guide_compat" env:"MQTT_VENUS_GUIDE_COMPAT" description:"Enable guide-style settings/0/Settings/CGwacs compatibility paths for Home Assistant controls."`
+		}
 		Username     string `long:"mqtt.username" env:"MQTT_USERNAME" default:"" description:"Set the MQTT username"`
 		Password     string `long:"mqtt.password" env:"MQTT_PASSWORD" default:"" description:"Set the MQTT password"`
 		PasswordFile string `long:"mqtt.password-file" env:"MQTT_PASSWORD_FILE" default:"" description:"Path to a file containing the MQTT password"`
@@ -40,6 +62,9 @@ type config struct {
 
 func parseConfig() (*config, error) {
 	conf := &config{}
+	// go-flags bool options cannot use struct-tag defaults; keep intended behavior via struct initialization.
+	conf.MQTT.Venus.SubscribeWrites = true
+	conf.MQTT.Venus.GuideCompat = true
 	parser := flags.NewParser(conf, flags.Default)
 	if _, err := parser.Parse(); err != nil {
 		return nil, err

cmd/invertergui/main.go

@@ -36,15 +36,17 @@ import (
 	"net"
 	"net/http"
 	"os"
+	"sort"
+	"strings"
 
-	"invertergui/mk2core"
+	"git.coadcorp.com/nathan/invertergui/mk2core"
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
-	"invertergui/plugins/cli"
+	"git.coadcorp.com/nathan/invertergui/plugins/cli"
-	"invertergui/plugins/mqttclient"
+	"git.coadcorp.com/nathan/invertergui/plugins/mqttclient"
-	"invertergui/plugins/munin"
+	"git.coadcorp.com/nathan/invertergui/plugins/munin"
-	"invertergui/plugins/prometheus"
+	"git.coadcorp.com/nathan/invertergui/plugins/prometheus"
-	"invertergui/plugins/webui"
+	"git.coadcorp.com/nathan/invertergui/plugins/webui"
-	"invertergui/plugins/webui/static"
+	"git.coadcorp.com/nathan/invertergui/plugins/webui/static"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/sirupsen/logrus"
 	"github.com/tarm/serial"
@@ -55,6 +57,7 @@ var log = logrus.WithField("ctx", "inverter-gui")
 func main() {
 	conf, err := parseConfig()
 	if err != nil {
+		log.WithError(err).Error("Could not parse configuration")
 		os.Exit(1)
 	}
 	log.Info("Starting invertergui")
@@ -63,16 +66,42 @@ func main() {
 		log.Fatalf("Could not parse log level: %v", err)
 	}
 	logrus.SetLevel(logLevel)
+	log.WithFields(logrus.Fields{
+		"loglevel":           conf.Loglevel,
+		"address":            conf.Address,
+		"read_only":          conf.ReadOnly,
+		"data_source":        conf.Data.Source,
+		"data_host":          conf.Data.Host,
+		"data_device":        conf.Data.Device,
+		"cli_enabled":        conf.Cli.Enabled,
+		"mqtt_enabled":       conf.MQTT.Enabled,
+		"mqtt_broker":        conf.MQTT.Broker,
+		"mqtt_topic":         conf.MQTT.Topic,
+		"mqtt_command_topic": conf.MQTT.CommandTopic,
+		"mqtt_status_topic":  conf.MQTT.StatusTopic,
+		"mqtt_device_id":     conf.MQTT.DeviceID,
+		"mqtt_history_size":  conf.MQTT.HistorySize,
+		"mqtt_ha_enabled":    conf.MQTT.HA.Enabled,
+		"mqtt_venus_enabled": conf.MQTT.Venus.Enabled,
+		"mqtt_venus_portal":  conf.MQTT.Venus.PortalID,
+		"mqtt_venus_service": conf.MQTT.Venus.Service,
+		"mqtt_venus_prefix":  conf.MQTT.Venus.TopicPrefix,
+		"mqtt_venus_guide":   conf.MQTT.Venus.GuideCompat,
+		"control_profile":    conf.Control.Profile,
+		"control_modes":      conf.Control.AllowedPanelModes,
+	}).Info("Configuration loaded")
 
 	mk2, err := getMk2Device(conf.Data.Source, conf.Data.Host, conf.Data.Device)
 	if err != nil {
 		log.Fatalf("Could not open data source: %v", err)
 	}
 	defer mk2.Close()
+	log.Info("MK2 device connection established")
 
 	core := mk2core.NewCore(mk2)
 
 	if conf.Cli.Enabled {
+		log.Info("CLI plugin enabled")
 		cli.NewCli(core.NewSubscription())
 	}
 
@@ -80,21 +109,77 @@ func main() {
 	var writer mk2driver.SettingsWriter
 	if w, ok := mk2.(mk2driver.SettingsWriter); ok {
 		writer = w
+		log.Info("MK2 data source supports settings writes")
+	} else {
+		log.Warn("MK2 data source does not support settings writes")
+	}
+	if conf.ReadOnly {
+		if writer != nil {
+			log.Warn("READ_ONLY enabled; disabling all write operations")
+		} else {
+			log.Info("READ_ONLY enabled")
+		}
+		writer = nil
+	} else if writer != nil {
+		allowedPanelStates, allowedPanelModeNames, parseErr := parseAllowedPanelModes(conf.Control.AllowedPanelModes)
+		if parseErr != nil {
+			log.WithError(parseErr).Fatal("Invalid control.allowed_panel_modes configuration")
+		}
+
+		policyProfile := mk2driver.WriterProfile(strings.ToLower(strings.TrimSpace(conf.Control.Profile)))
+		if policyProfile == "" {
+			policyProfile = mk2driver.WriterProfileNormal
+		}
+		if policyProfile != mk2driver.WriterProfileNormal &&
+			policyProfile != mk2driver.WriterProfileMaintenance &&
+			policyProfile != mk2driver.WriterProfileReadOnly {
+			log.WithField("profile", conf.Control.Profile).Warn("Unknown control profile; defaulting to normal")
+			policyProfile = mk2driver.WriterProfileNormal
+		}
+
+		var maxCurrentLimit *float64
+		if conf.Control.MaxCurrentLimit > 0 {
+			limit := conf.Control.MaxCurrentLimit
+			maxCurrentLimit = &limit
+		}
+
+		writer = mk2driver.NewManagedWriter(writer, mk2driver.WriterPolicy{
+			Profile:               policyProfile,
+			MaxCurrentLimitA:      maxCurrentLimit,
+			ModeChangeMinInterval: conf.Control.ModeChangeMinInterval,
+			LockoutWindow:         conf.Control.LockoutWindow,
+			AllowedPanelStates:    allowedPanelStates,
+		})
+
+		allowedModes := "all"
+		if len(allowedPanelModeNames) > 0 {
+			allowedModes = strings.Join(allowedPanelModeNames, ",")
+		}
+		log.WithFields(logrus.Fields{
+			"profile":                  policyProfile,
+			"max_current_limit":        conf.Control.MaxCurrentLimit,
+			"mode_change_min_interval": conf.Control.ModeChangeMinInterval,
+			"lockout_window":           conf.Control.LockoutWindow,
+			"allowed_panel_modes":      allowedModes,
+		}).Info("Write policy/arbitration layer enabled")
 	}
 	gui := webui.NewWebGui(core.NewSubscription(), writer)
 	http.Handle("/", static.New())
 	http.Handle("/ws", http.HandlerFunc(gui.ServeHub))
 	http.Handle("/api/remote-panel/state", http.HandlerFunc(gui.ServeRemotePanelState))
 	http.Handle("/api/remote-panel/standby", http.HandlerFunc(gui.ServeRemotePanelStandby))
+	log.Info("Web UI routes registered")
 
 	// Munin
 	mu := munin.NewMunin(core.NewSubscription())
 	http.Handle("/munin", http.HandlerFunc(mu.ServeMuninHTTP))
 	http.Handle("/muninconfig", http.HandlerFunc(mu.ServeMuninConfigHTTP))
+	log.Info("Munin routes registered")
 
 	// Prometheus
 	prometheus.NewPrometheus(core.NewSubscription())
 	http.Handle("/metrics", promhttp.Handler())
+	log.Info("Prometheus route registered")
 
 	// MQTT
 	if conf.MQTT.Enabled {
@@ -104,12 +189,25 @@ func main() {
 			CommandTopic: conf.MQTT.CommandTopic,
 			StatusTopic:  conf.MQTT.StatusTopic,
 			ClientID:     conf.MQTT.ClientID,
+			DeviceID:     conf.MQTT.DeviceID,
+			HistorySize:  conf.MQTT.HistorySize,
+			InstanceID:   conf.MQTT.InstanceID,
+			Phase:        conf.MQTT.Phase,
+			PhaseGroup:   conf.MQTT.PhaseGroup,
 			HomeAssistant: mqttclient.HomeAssistantConfig{
 				Enabled:         conf.MQTT.HA.Enabled,
 				DiscoveryPrefix: conf.MQTT.HA.DiscoveryPrefix,
 				NodeID:          conf.MQTT.HA.NodeID,
 				DeviceName:      conf.MQTT.HA.DeviceName,
 			},
+			Venus: mqttclient.VenusConfig{
+				Enabled:         conf.MQTT.Venus.Enabled,
+				PortalID:        conf.MQTT.Venus.PortalID,
+				Service:         conf.MQTT.Venus.Service,
+				SubscribeWrites: conf.MQTT.Venus.SubscribeWrites,
+				TopicPrefix:     conf.MQTT.Venus.TopicPrefix,
+				GuideCompat:     conf.MQTT.Venus.GuideCompat,
+			},
 			Username: conf.MQTT.Username,
 			Password: conf.MQTT.Password,
 		}
@@ -119,6 +217,7 @@ func main() {
 		if err := mqttclient.New(core.NewSubscription(), writer, mqttConf); err != nil {
 			log.Fatalf("Could not setup MQTT client: %v", err)
 		}
+		log.Info("MQTT client initialized")
 	}
 	log.Infof("Invertergui web server starting on: %v", conf.Address)
 
@@ -134,12 +233,14 @@ func getMk2Device(source, ip, dev string) (mk2driver.Mk2, error) {
 
 	switch source {
 	case "serial":
+		log.WithField("device", dev).Info("Opening serial MK2 source")
 		serialConfig := &serial.Config{Name: dev, Baud: 2400}
 		p, err = serial.OpenPort(serialConfig)
 		if err != nil {
 			return nil, err
 		}
 	case "tcp":
+		log.WithField("host", ip).Info("Opening TCP MK2 source")
 		tcpAddr, err = net.ResolveTCPAddr("tcp", ip)
 		if err != nil {
 			return nil, err
@@ -149,6 +250,7 @@ func getMk2Device(source, ip, dev string) (mk2driver.Mk2, error) {
 			return nil, err
 		}
 	case "mock":
+		log.Info("Using mock MK2 data source")
 		return mk2driver.NewMk2Mock(), nil
 	default:
 		return nil, fmt.Errorf("Invalid source selection: %v\nUse \"serial\", \"tcp\" or \"mock\"", source)
@@ -158,6 +260,58 @@ func getMk2Device(source, ip, dev string) (mk2driver.Mk2, error) {
 	if err != nil {
 		return nil, err
 	}
+	log.WithField("source", source).Info("MK2 connection ready")
 
 	return mk2, nil
 }
+
+func parseAllowedPanelModes(raw string) (map[mk2driver.PanelSwitchState]struct{}, []string, error) {
+	if strings.TrimSpace(raw) == "" {
+		return nil, nil, nil
+	}
+
+	out := make(map[mk2driver.PanelSwitchState]struct{})
+	names := make([]string, 0, 4)
+
+	for _, token := range strings.Split(raw, ",") {
+		mode := strings.ToLower(strings.TrimSpace(token))
+		if mode == "" {
+			continue
+		}
+
+		var state mk2driver.PanelSwitchState
+		var canonical string
+
+		switch mode {
+		case "on":
+			state = mk2driver.PanelSwitchOn
+			canonical = "on"
+		case "off":
+			state = mk2driver.PanelSwitchOff
+			canonical = "off"
+		case "charger_only", "charger-only":
+			state = mk2driver.PanelSwitchChargerOnly
+			canonical = "charger_only"
+		case "inverter_only", "inverter-only":
+			state = mk2driver.PanelSwitchInverterOnly
+			canonical = "inverter_only"
+		default:
+			return nil, nil, fmt.Errorf(
+				"unsupported panel mode %q in control.allowed_panel_modes; supported values: on, off, charger_only, inverter_only",
+				token,
+			)
+		}
+
+		if _, exists := out[state]; !exists {
+			out[state] = struct{}{}
+			names = append(names, canonical)
+		}
+	}
+
+	if len(out) == 0 {
+		return nil, nil, fmt.Errorf("control.allowed_panel_modes is set but no valid modes were provided")
+	}
+
+	sort.Strings(names)
+	return out, names, nil
+}

cmd/invertergui/main_test.go

@@ -0,0 +1,46 @@
+package main
+
+import (
+	"testing"
+
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
+)
+
+func TestParseAllowedPanelModesEmpty(t *testing.T) {
+	states, names, err := parseAllowedPanelModes("")
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if states != nil {
+		t.Fatalf("expected nil state map for empty input, got %#v", states)
+	}
+	if names != nil {
+		t.Fatalf("expected nil names for empty input, got %#v", names)
+	}
+}
+
+func TestParseAllowedPanelModesValid(t *testing.T) {
+	states, names, err := parseAllowedPanelModes("off, charger-only,off")
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if len(states) != 2 {
+		t.Fatalf("expected 2 allowed states, got %d", len(states))
+	}
+	if _, ok := states[mk2driver.PanelSwitchOff]; !ok {
+		t.Fatalf("off should be allowed")
+	}
+	if _, ok := states[mk2driver.PanelSwitchChargerOnly]; !ok {
+		t.Fatalf("charger_only should be allowed")
+	}
+	if len(names) != 2 {
+		t.Fatalf("expected 2 names, got %d", len(names))
+	}
+}
+
+func TestParseAllowedPanelModesInvalid(t *testing.T) {
+	_, _, err := parseAllowedPanelModes("off,invalid_mode")
+	if err == nil {
+		t.Fatal("expected error for invalid mode")
+	}
+}

custom_components/victron_mk2_mqtt/__init__.py

@@ -0,0 +1,186 @@
+"""Home Assistant integration for invertergui MQTT topics."""
+
+from __future__ import annotations
+
+from typing import Any
+
+import voluptuous as vol
+from homeassistant.const import CONF_NAME
+from homeassistant.core import HomeAssistant, ServiceCall
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers import config_validation as cv, discovery
+from homeassistant.helpers.typing import ConfigType
+
+from .const import (
+    ATTR_ESS_MAX_CHARGE_POWER,
+    ATTR_ESS_MAX_DISCHARGE_POWER,
+    ATTR_ESS_MODE,
+    ATTR_ESS_SETPOINT,
+    ATTR_CURRENT_LIMIT,
+    ATTR_MODE,
+    CONF_COMMAND_TOPIC,
+    CONF_STATE_TOPIC,
+    CONF_STATUS_TOPIC,
+    CONF_TOPIC_ROOT,
+    CONF_VENUS_GUIDE_COMPAT,
+    CONF_VENUS_PORTAL_ID,
+    CONF_VENUS_TOPIC_PREFIX,
+    DATA_BRIDGE,
+    DEFAULT_COMMAND_TOPIC,
+    DEFAULT_NAME,
+    DEFAULT_STATE_TOPIC,
+    DEFAULT_STATUS_TOPIC,
+    DEFAULT_TOPIC_ROOT,
+    DEFAULT_VENUS_GUIDE_COMPAT,
+    DEFAULT_VENUS_PORTAL_ID,
+    DEFAULT_VENUS_TOPIC_PREFIX,
+    DOMAIN,
+    PANEL_MODES,
+    PLATFORMS,
+    SERVICE_SET_ESS_CONTROL,
+    SERVICE_SET_REMOTE_PANEL_STATE,
+)
+from .coordinator import VictronMqttBridge
+
+CONFIG_SCHEMA = vol.Schema(
+    {
+        DOMAIN: vol.Schema(
+            {
+                vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
+                vol.Optional(CONF_STATE_TOPIC, default=DEFAULT_STATE_TOPIC): cv.string,
+                vol.Optional(
+                    CONF_COMMAND_TOPIC, default=DEFAULT_COMMAND_TOPIC
+                ): cv.string,
+                vol.Optional(CONF_STATUS_TOPIC, default=DEFAULT_STATUS_TOPIC): cv.string,
+                vol.Optional(CONF_TOPIC_ROOT): cv.string,
+                vol.Optional(CONF_VENUS_PORTAL_ID, default=DEFAULT_VENUS_PORTAL_ID): cv.string,
+                vol.Optional(CONF_VENUS_TOPIC_PREFIX, default=DEFAULT_VENUS_TOPIC_PREFIX): cv.string,
+                vol.Optional(CONF_VENUS_GUIDE_COMPAT, default=DEFAULT_VENUS_GUIDE_COMPAT): cv.boolean,
+            }
+        )
+    },
+    extra=vol.ALLOW_EXTRA,
+)
+
+SERVICE_SET_REMOTE_PANEL_STATE_SCHEMA = vol.Schema(
+    {
+        vol.Optional(ATTR_MODE): vol.In(PANEL_MODES),
+        vol.Optional(ATTR_CURRENT_LIMIT): vol.Coerce(float),
+    },
+    extra=vol.PREVENT_EXTRA,
+)
+
+SERVICE_SET_ESS_CONTROL_SCHEMA = vol.Schema(
+    {
+        vol.Optional(ATTR_ESS_SETPOINT): vol.Coerce(float),
+        vol.Optional(ATTR_ESS_MAX_CHARGE_POWER): vol.Coerce(float),
+        vol.Optional(ATTR_ESS_MAX_DISCHARGE_POWER): vol.Coerce(float),
+        vol.Optional(ATTR_ESS_MODE): vol.Coerce(int),
+    },
+    extra=vol.PREVENT_EXTRA,
+)
+
+
+def mqtt_topic_root(topic: str) -> str:
+    """Match invertergui MQTT root behavior."""
+    cleaned = topic.strip().strip("/")
+    if not cleaned:
+        return DEFAULT_TOPIC_ROOT
+    if cleaned.endswith("/updates"):
+        root = cleaned[: -len("/updates")]
+        if root:
+            return root
+    return cleaned
+
+
+async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
+    """Set up Victron MK2 MQTT integration from YAML."""
+    conf = config.get(DOMAIN)
+    if conf is None:
+        return True
+
+    setup_conf: dict[str, Any] = dict(conf)
+    if not setup_conf.get(CONF_TOPIC_ROOT):
+        setup_conf[CONF_TOPIC_ROOT] = mqtt_topic_root(setup_conf[CONF_STATE_TOPIC])
+
+    bridge = VictronMqttBridge(hass, setup_conf)
+    await bridge.async_setup()
+
+    hass.data.setdefault(DOMAIN, {})
+    hass.data[DOMAIN][DATA_BRIDGE] = bridge
+
+    await _register_services(hass, bridge)
+
+    for platform in PLATFORMS:
+        hass.async_create_task(
+            discovery.async_load_platform(hass, platform, DOMAIN, {}, config)
+        )
+
+    return True
+
+
+async def _register_services(hass: HomeAssistant, bridge: VictronMqttBridge) -> None:
+    """Register integration services."""
+    if hass.services.has_service(DOMAIN, SERVICE_SET_REMOTE_PANEL_STATE):
+        return
+
+    async def handle_set_remote_panel_state(call: ServiceCall) -> None:
+        mode = call.data.get(ATTR_MODE)
+        current_limit = call.data.get(ATTR_CURRENT_LIMIT)
+
+        if mode is None and current_limit is None:
+            raise HomeAssistantError("Provide at least one of mode or current_limit")
+        if current_limit is not None and current_limit < 0:
+            raise HomeAssistantError("current_limit must be >= 0")
+
+        payload: dict[str, Any] = {"kind": "panel_state"}
+        if mode is not None:
+            payload["switch"] = mode
+        if current_limit is not None:
+            payload["current_limit"] = float(current_limit)
+
+        await bridge.async_publish_command(payload)
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_SET_REMOTE_PANEL_STATE,
+        handle_set_remote_panel_state,
+        schema=SERVICE_SET_REMOTE_PANEL_STATE_SCHEMA,
+    )
+
+    async def handle_set_ess_control(call: ServiceCall) -> None:
+        setpoint = call.data.get(ATTR_ESS_SETPOINT)
+        max_charge = call.data.get(ATTR_ESS_MAX_CHARGE_POWER)
+        max_discharge = call.data.get(ATTR_ESS_MAX_DISCHARGE_POWER)
+        ess_mode = call.data.get(ATTR_ESS_MODE)
+
+        if all(value is None for value in (setpoint, max_charge, max_discharge, ess_mode)):
+            raise HomeAssistantError(
+                "Provide at least one of ess_setpoint, ess_max_charge_power, ess_max_discharge_power, or ess_mode"
+            )
+        if max_charge is not None and max_charge < 0:
+            raise HomeAssistantError("ess_max_charge_power must be >= 0")
+        if max_discharge is not None and max_discharge < 0:
+            raise HomeAssistantError("ess_max_discharge_power must be >= 0")
+        if ess_mode is not None and ess_mode not in (9, 10):
+            raise HomeAssistantError("ess_mode must be 9 or 10")
+
+        commands: list[dict[str, Any]] = []
+        if setpoint is not None:
+            commands.append({"kind": "ess_setpoint", "value": float(setpoint)})
+        if max_charge is not None:
+            commands.append({"kind": "ess_max_charge_power", "value": float(max_charge)})
+        if max_discharge is not None:
+            commands.append({"kind": "ess_max_discharge_power", "value": float(max_discharge)})
+        if ess_mode is not None:
+            commands.append({"kind": "ess_mode", "value": int(ess_mode)})
+
+        for payload in commands:
+            await bridge.async_publish_command(payload)
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_SET_ESS_CONTROL,
+        handle_set_ess_control,
+        schema=SERVICE_SET_ESS_CONTROL_SCHEMA,
+    )

custom_components/victron_mk2_mqtt/binary_sensor.py

@@ -0,0 +1,48 @@
+"""Binary sensors for Victron MK2 MQTT integration."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from homeassistant.components.binary_sensor import BinarySensorEntity
+from homeassistant.const import EntityCategory
+from homeassistant.core import HomeAssistant
+
+from .const import DATA_BRIDGE, DOMAIN
+from .coordinator import VictronMqttBridge
+from .entity import VictronMqttEntity
+
+
+async def async_setup_platform(
+    hass: HomeAssistant,
+    config: dict[str, Any],
+    async_add_entities,
+    discovery_info: dict[str, Any] | None = None,
+) -> None:
+    """Set up Victron binary sensors."""
+    bridge: VictronMqttBridge = hass.data[DOMAIN][DATA_BRIDGE]
+    async_add_entities([VictronDataValidBinarySensor(bridge)])
+
+
+class VictronDataValidBinarySensor(VictronMqttEntity, BinarySensorEntity):
+    """MQTT data validity sensor."""
+
+    _attr_name = "Data Valid"
+    _attr_entity_category = EntityCategory.DIAGNOSTIC
+    _attr_icon = "mdi:check-network-outline"
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        super().__init__(bridge)
+        self._attr_unique_id = f"{bridge.topic_root}_data_valid"
+
+    @property
+    def is_on(self) -> bool:
+        value = self.bridge.metric("Valid")
+        if isinstance(value, bool):
+            return value
+        if isinstance(value, (int, float)):
+            return value != 0
+        if isinstance(value, str):
+            normalized = value.strip().lower()
+            return normalized in {"1", "true", "on", "yes"}
+        return False

custom_components/victron_mk2_mqtt/const.py

@@ -0,0 +1,48 @@
+"""Constants for the Victron MK2 MQTT integration."""
+
+from __future__ import annotations
+
+DOMAIN = "victron_mk2_mqtt"
+
+CONF_STATE_TOPIC = "state_topic"
+CONF_COMMAND_TOPIC = "command_topic"
+CONF_STATUS_TOPIC = "status_topic"
+CONF_TOPIC_ROOT = "topic_root"
+CONF_NAME = "name"
+CONF_VENUS_PORTAL_ID = "venus_portal_id"
+CONF_VENUS_TOPIC_PREFIX = "venus_topic_prefix"
+CONF_VENUS_GUIDE_COMPAT = "venus_guide_compat"
+
+DEFAULT_STATE_TOPIC = "invertergui/updates"
+DEFAULT_COMMAND_TOPIC = "invertergui/settings/set"
+DEFAULT_STATUS_TOPIC = "invertergui/settings/status"
+DEFAULT_TOPIC_ROOT = "invertergui"
+DEFAULT_NAME = "Victron Inverter"
+DEFAULT_VENUS_PORTAL_ID = "invertergui"
+DEFAULT_VENUS_TOPIC_PREFIX = ""
+DEFAULT_VENUS_GUIDE_COMPAT = True
+
+PLATFORMS = ("sensor", "binary_sensor", "select", "number", "switch")
+
+DATA_BRIDGE = "bridge"
+
+ATTR_MODE = "mode"
+ATTR_CURRENT_LIMIT = "current_limit"
+ATTR_ESS_SETPOINT = "ess_setpoint"
+ATTR_ESS_MAX_CHARGE_POWER = "ess_max_charge_power"
+ATTR_ESS_MAX_DISCHARGE_POWER = "ess_max_discharge_power"
+ATTR_ESS_MODE = "ess_mode"
+
+SERVICE_SET_REMOTE_PANEL_STATE = "set_remote_panel_state"
+SERVICE_SET_ESS_CONTROL = "set_ess_control"
+
+PANEL_MODE_CHARGER_ONLY = "charger_only"
+PANEL_MODE_INVERTER_ONLY = "inverter_only"
+PANEL_MODE_ON = "on"
+PANEL_MODE_OFF = "off"
+PANEL_MODES = (
+    PANEL_MODE_CHARGER_ONLY,
+    PANEL_MODE_INVERTER_ONLY,
+    PANEL_MODE_ON,
+    PANEL_MODE_OFF,
+)

custom_components/victron_mk2_mqtt/coordinator.py

@@ -0,0 +1,333 @@
+"""MQTT bridge for Victron MK2 integration."""
+
+from __future__ import annotations
+
+import json
+import logging
+from collections.abc import Callable
+from typing import Any
+
+from homeassistant.components import mqtt
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers.device_registry import DeviceInfo
+
+from .const import (
+    CONF_COMMAND_TOPIC,
+    CONF_NAME,
+    CONF_STATE_TOPIC,
+    CONF_STATUS_TOPIC,
+    CONF_TOPIC_ROOT,
+    CONF_VENUS_GUIDE_COMPAT,
+    CONF_VENUS_PORTAL_ID,
+    CONF_VENUS_TOPIC_PREFIX,
+    DOMAIN,
+    PANEL_MODES,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class VictronMqttBridge:
+    """Maintain MQTT state and command publishing for Victron entities."""
+
+    def __init__(self, hass: HomeAssistant, config: dict[str, Any]) -> None:
+        self.hass = hass
+
+        self.name: str = config[CONF_NAME]
+        self.state_topic: str = config[CONF_STATE_TOPIC]
+        self.command_topic: str = config[CONF_COMMAND_TOPIC]
+        self.status_topic: str = config[CONF_STATUS_TOPIC]
+        self.topic_root: str = config[CONF_TOPIC_ROOT]
+        self.venus_portal_id: str = config[CONF_VENUS_PORTAL_ID]
+        self.venus_topic_prefix: str = config[CONF_VENUS_TOPIC_PREFIX]
+        self.venus_guide_compat: bool = bool(config[CONF_VENUS_GUIDE_COMPAT])
+
+        self.panel_mode_state_topic = f"{self.topic_root}/homeassistant/remote_panel_mode/state"
+        self.current_limit_state_topic = (
+            f"{self.topic_root}/homeassistant/remote_panel_current_limit/state"
+        )
+        self.standby_state_topic = f"{self.topic_root}/homeassistant/remote_panel_standby/state"
+
+        self.telemetry: dict[str, Any] = {}
+        self.panel_mode: str | None = None
+        self.current_limit: float | None = None
+        self.standby: bool | None = None
+        self.last_error: str | None = None
+        self.ess_setpoint: float | None = None
+        self.ess_max_charge_power: float | None = None
+        self.ess_max_discharge_power: float | None = None
+        self.ess_mode: int | None = None
+
+        self._listeners: set[Callable[[], None]] = set()
+        self._unsubscribers: list[Callable[[], None]] = []
+
+        venus_base = f"N/{self.venus_portal_id}/settings/0/Settings/CGwacs"
+        prefix = self.venus_topic_prefix.strip().strip("/")
+        if prefix:
+            venus_base = f"{prefix}/{venus_base}"
+        self.ess_setpoint_state_topic = f"{venus_base}/AcPowerSetPoint"
+        self.ess_max_charge_state_topic = f"{venus_base}/MaxChargePower"
+        self.ess_max_discharge_state_topic = f"{venus_base}/MaxDischargePower"
+        self.ess_mode_state_topic = f"{venus_base}/BatteryLife/State"
+
+    @property
+    def device_info(self) -> DeviceInfo:
+        """Return shared Home Assistant device metadata."""
+        return DeviceInfo(
+            identifiers={(DOMAIN, self.topic_root)},
+            name=self.name,
+            manufacturer="Victron Energy",
+            model="VE.Bus via invertergui MQTT",
+        )
+
+    async def async_setup(self) -> None:
+        """Subscribe to required MQTT topics."""
+        _LOGGER.info(
+            "Subscribing Victron MQTT bridge topics state=%s command=%s status=%s",
+            self.state_topic,
+            self.command_topic,
+            self.status_topic,
+        )
+        self._unsubscribers.append(
+            await mqtt.async_subscribe(
+                self.hass, self.state_topic, self._handle_state_message, qos=1
+            )
+        )
+        self._unsubscribers.append(
+            await mqtt.async_subscribe(
+                self.hass,
+                self.panel_mode_state_topic,
+                self._handle_panel_mode_message,
+                qos=1,
+            )
+        )
+        self._unsubscribers.append(
+            await mqtt.async_subscribe(
+                self.hass,
+                self.current_limit_state_topic,
+                self._handle_current_limit_message,
+                qos=1,
+            )
+        )
+        self._unsubscribers.append(
+            await mqtt.async_subscribe(
+                self.hass, self.standby_state_topic, self._handle_standby_message, qos=1
+            )
+        )
+        if self.venus_guide_compat:
+            self._unsubscribers.append(
+                await mqtt.async_subscribe(
+                    self.hass,
+                    self.ess_setpoint_state_topic,
+                    self._handle_ess_setpoint_message,
+                    qos=1,
+                )
+            )
+            self._unsubscribers.append(
+                await mqtt.async_subscribe(
+                    self.hass,
+                    self.ess_max_charge_state_topic,
+                    self._handle_ess_max_charge_message,
+                    qos=1,
+                )
+            )
+            self._unsubscribers.append(
+                await mqtt.async_subscribe(
+                    self.hass,
+                    self.ess_max_discharge_state_topic,
+                    self._handle_ess_max_discharge_message,
+                    qos=1,
+                )
+            )
+            self._unsubscribers.append(
+                await mqtt.async_subscribe(
+                    self.hass,
+                    self.ess_mode_state_topic,
+                    self._handle_ess_mode_message,
+                    qos=1,
+                )
+            )
+        if self.status_topic:
+            self._unsubscribers.append(
+                await mqtt.async_subscribe(
+                    self.hass, self.status_topic, self._handle_status_message, qos=1
+                )
+            )
+
+    async def async_shutdown(self) -> None:
+        """Unsubscribe all MQTT subscriptions."""
+        while self._unsubscribers:
+            unsub = self._unsubscribers.pop()
+            unsub()
+
+    @callback
+    def async_add_listener(self, listener: Callable[[], None]) -> Callable[[], None]:
+        """Register a state listener."""
+        self._listeners.add(listener)
+
+        def remove() -> None:
+            self._listeners.discard(listener)
+
+        return remove
+
+    @callback
+    def _notify_listeners(self) -> None:
+        """Notify all entities that state changed."""
+        for listener in tuple(self._listeners):
+            listener()
+
+    @staticmethod
+    def _payload_text(payload: Any) -> str:
+        if isinstance(payload, bytes):
+            return payload.decode("utf-8", errors="ignore")
+        if isinstance(payload, str):
+            return payload
+        return str(payload)
+
+    @callback
+    def _handle_state_message(self, msg: Any) -> None:
+        raw_payload = self._payload_text(msg.payload)
+        try:
+            payload = json.loads(raw_payload)
+        except json.JSONDecodeError as err:
+            _LOGGER.warning("Ignoring invalid state JSON from %s: %s", msg.topic, err)
+            return
+
+        if not isinstance(payload, dict):
+            _LOGGER.warning("Ignoring state payload from %s: expected object", msg.topic)
+            return
+
+        self.telemetry = payload
+        self._notify_listeners()
+
+    @callback
+    def _handle_panel_mode_message(self, msg: Any) -> None:
+        mode = self._payload_text(msg.payload).strip().lower()
+        if mode not in PANEL_MODES:
+            _LOGGER.debug("Ignoring unknown panel mode payload %r", msg.payload)
+            return
+
+        self.panel_mode = mode
+        self._notify_listeners()
+
+    @callback
+    def _handle_current_limit_message(self, msg: Any) -> None:
+        payload = self._payload_text(msg.payload).strip()
+        if not payload:
+            self.current_limit = None
+            self._notify_listeners()
+            return
+        try:
+            self.current_limit = float(payload)
+        except ValueError:
+            _LOGGER.debug("Ignoring invalid current limit payload %r", msg.payload)
+            return
+
+        self._notify_listeners()
+
+    @callback
+    def _handle_standby_message(self, msg: Any) -> None:
+        value = self._payload_text(msg.payload).strip().lower()
+        if value in {"on", "1", "true"}:
+            self.standby = True
+        elif value in {"off", "0", "false"}:
+            self.standby = False
+        else:
+            _LOGGER.debug("Ignoring invalid standby payload %r", msg.payload)
+            return
+
+        self._notify_listeners()
+
+    @callback
+    def _handle_status_message(self, msg: Any) -> None:
+        raw_payload = self._payload_text(msg.payload)
+        try:
+            payload = json.loads(raw_payload)
+        except json.JSONDecodeError:
+            return
+        if not isinstance(payload, dict):
+            return
+
+        if payload.get("status") == "error":
+            err = payload.get("error")
+            self.last_error = str(err) if err is not None else "unknown error"
+        else:
+            self.last_error = None
+        self._notify_listeners()
+
+    @callback
+    def _handle_ess_setpoint_message(self, msg: Any) -> None:
+        value = self._decode_venus_numeric(msg.payload)
+        if value is None:
+            return
+        self.ess_setpoint = value
+        self._notify_listeners()
+
+    @callback
+    def _handle_ess_max_charge_message(self, msg: Any) -> None:
+        value = self._decode_venus_numeric(msg.payload)
+        if value is None:
+            return
+        self.ess_max_charge_power = value
+        self._notify_listeners()
+
+    @callback
+    def _handle_ess_max_discharge_message(self, msg: Any) -> None:
+        value = self._decode_venus_numeric(msg.payload)
+        if value is None:
+            return
+        self.ess_max_discharge_power = value
+        self._notify_listeners()
+
+    @callback
+    def _handle_ess_mode_message(self, msg: Any) -> None:
+        value = self._decode_venus_numeric(msg.payload)
+        if value is None:
+            return
+        self.ess_mode = int(value)
+        self._notify_listeners()
+
+    def _decode_venus_numeric(self, payload: Any) -> float | None:
+        raw_payload = self._payload_text(payload)
+        try:
+            data = json.loads(raw_payload)
+        except json.JSONDecodeError:
+            _LOGGER.debug("Ignoring invalid Venus payload %r", raw_payload)
+            return None
+
+        value = data.get("value") if isinstance(data, dict) else None
+        if value is None:
+            return None
+        try:
+            return float(value)
+        except (TypeError, ValueError):
+            _LOGGER.debug("Ignoring non-numeric Venus payload value %r", value)
+            return None
+
+    async def async_publish_command(self, payload: dict[str, Any]) -> None:
+        """Publish a control command payload to invertergui command topic."""
+        if not self.command_topic:
+            raise HomeAssistantError("MQTT command topic is not configured")
+
+        mqtt.async_publish(
+            self.hass,
+            self.command_topic,
+            json.dumps(payload, separators=(",", ":")),
+            qos=1,
+            retain=False,
+        )
+
+    def metric(self, key: str) -> Any:
+        """Read a telemetry key."""
+        return self.telemetry.get(key)
+
+    def metric_float(self, key: str) -> float | None:
+        """Read and coerce telemetry value to float."""
+        value = self.metric(key)
+        if value is None:
+            return None
+        try:
+            return float(value)
+        except (TypeError, ValueError):
+            return None

custom_components/victron_mk2_mqtt/entity.py

@@ -0,0 +1,29 @@
+"""Shared entity base for Victron MK2 MQTT."""
+
+from __future__ import annotations
+
+from homeassistant.helpers.entity import Entity
+
+from .coordinator import VictronMqttBridge
+
+
+class VictronMqttEntity(Entity):
+    """Base entity bound to shared MQTT bridge."""
+
+    _attr_should_poll = False
+    _attr_has_entity_name = True
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        self.bridge = bridge
+
+    @property
+    def device_info(self):
+        """Return the shared device info."""
+        return self.bridge.device_info
+
+    async def async_added_to_hass(self) -> None:
+        """Register for coordinator updates."""
+        self.async_on_remove(self.bridge.async_add_listener(self._handle_bridge_update))
+
+    def _handle_bridge_update(self) -> None:
+        self.async_write_ha_state()

custom_components/victron_mk2_mqtt/manifest.json

@@ -0,0 +1,14 @@
+{
+  "domain": "victron_mk2_mqtt",
+  "name": "Victron MK2 MQTT",
+  "version": "0.1.0",
+  "documentation": "https://git.coadcorp.com/nathan/invertergui",
+  "issue_tracker": "https://git.coadcorp.com/nathan/invertergui/issues",
+  "dependencies": [
+    "mqtt"
+  ],
+  "codeowners": [
+    "@nathan"
+  ],
+  "iot_class": "local_push"
+}

custom_components/victron_mk2_mqtt/number.py

@@ -0,0 +1,135 @@
+"""Number entities for Victron MK2 MQTT integration."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from homeassistant.components.number import NumberDeviceClass, NumberEntity, NumberMode
+from homeassistant.const import UnitOfElectricCurrent
+from homeassistant.core import HomeAssistant
+
+from .const import DATA_BRIDGE, DOMAIN
+from .coordinator import VictronMqttBridge
+from .entity import VictronMqttEntity
+
+
+async def async_setup_platform(
+    hass: HomeAssistant,
+    config: dict[str, Any],
+    async_add_entities,
+    discovery_info: dict[str, Any] | None = None,
+) -> None:
+    """Set up Victron number entities."""
+    bridge: VictronMqttBridge = hass.data[DOMAIN][DATA_BRIDGE]
+    entities: list[NumberEntity] = [VictronRemotePanelCurrentLimitNumber(bridge)]
+    if bridge.venus_guide_compat:
+        entities.extend(
+            [
+                VictronESSGridSetpointNumber(bridge),
+                VictronESSMaxChargePowerNumber(bridge),
+                VictronESSMaxDischargePowerNumber(bridge),
+            ]
+        )
+    async_add_entities(entities)
+
+
+class VictronRemotePanelCurrentLimitNumber(VictronMqttEntity, NumberEntity):
+    """Remote panel AC input current limit."""
+
+    _attr_name = "Remote Panel Current Limit"
+    _attr_icon = "mdi:current-ac"
+    _attr_native_min_value = 0.0
+    _attr_native_max_value = 100.0
+    _attr_native_step = 0.1
+    _attr_mode = NumberMode.BOX
+    _attr_device_class = NumberDeviceClass.CURRENT
+    _attr_native_unit_of_measurement = UnitOfElectricCurrent.AMPERE
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        super().__init__(bridge)
+        self._attr_unique_id = f"{bridge.topic_root}_remote_panel_current_limit"
+
+    @property
+    def native_value(self) -> float | None:
+        return self.bridge.current_limit
+
+    @property
+    def available(self) -> bool:
+        return bool(self.bridge.command_topic)
+
+    async def async_set_native_value(self, value: float) -> None:
+        await self.bridge.async_publish_command(
+            {"kind": "panel_state", "current_limit": float(value)}
+        )
+
+
+class _VictronESSNumberBase(VictronMqttEntity, NumberEntity):
+    """Base class for ESS compatibility numbers."""
+
+    _attr_mode = NumberMode.BOX
+    _attr_native_step = 1.0
+    _attr_native_min_value = -20000.0
+    _attr_native_max_value = 20000.0
+    _attr_native_unit_of_measurement = "W"
+    _attr_icon = "mdi:transmission-tower-export"
+
+    @property
+    def available(self) -> bool:
+        return bool(self.bridge.command_topic and self.bridge.venus_guide_compat)
+
+
+class VictronESSGridSetpointNumber(_VictronESSNumberBase):
+    """Guide-compatible ESS AC power setpoint."""
+
+    _attr_name = "ESS Grid Setpoint"
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        super().__init__(bridge)
+        self._attr_unique_id = f"{bridge.topic_root}_ess_grid_setpoint"
+
+    @property
+    def native_value(self) -> float | None:
+        return self.bridge.ess_setpoint
+
+    async def async_set_native_value(self, value: float) -> None:
+        await self.bridge.async_publish_command({"kind": "ess_setpoint", "value": float(value)})
+
+
+class VictronESSMaxChargePowerNumber(_VictronESSNumberBase):
+    """Guide-compatible ESS max charge power."""
+
+    _attr_name = "ESS Max Charge Power"
+    _attr_native_min_value = 0.0
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        super().__init__(bridge)
+        self._attr_unique_id = f"{bridge.topic_root}_ess_max_charge_power"
+
+    @property
+    def native_value(self) -> float | None:
+        return self.bridge.ess_max_charge_power
+
+    async def async_set_native_value(self, value: float) -> None:
+        await self.bridge.async_publish_command(
+            {"kind": "ess_max_charge_power", "value": float(value)}
+        )
+
+
+class VictronESSMaxDischargePowerNumber(_VictronESSNumberBase):
+    """Guide-compatible ESS max discharge power."""
+
+    _attr_name = "ESS Max Discharge Power"
+    _attr_native_min_value = 0.0
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        super().__init__(bridge)
+        self._attr_unique_id = f"{bridge.topic_root}_ess_max_discharge_power"
+
+    @property
+    def native_value(self) -> float | None:
+        return self.bridge.ess_max_discharge_power
+
+    async def async_set_native_value(self, value: float) -> None:
+        await self.bridge.async_publish_command(
+            {"kind": "ess_max_discharge_power", "value": float(value)}
+        )

custom_components/victron_mk2_mqtt/select.py

@@ -0,0 +1,46 @@
+"""Select entities for Victron MK2 MQTT integration."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from homeassistant.components.select import SelectEntity
+from homeassistant.core import HomeAssistant
+
+from .const import DATA_BRIDGE, DOMAIN, PANEL_MODES
+from .coordinator import VictronMqttBridge
+from .entity import VictronMqttEntity
+
+
+async def async_setup_platform(
+    hass: HomeAssistant,
+    config: dict[str, Any],
+    async_add_entities,
+    discovery_info: dict[str, Any] | None = None,
+) -> None:
+    """Set up Victron select entities."""
+    bridge: VictronMqttBridge = hass.data[DOMAIN][DATA_BRIDGE]
+    async_add_entities([VictronRemotePanelModeSelect(bridge)])
+
+
+class VictronRemotePanelModeSelect(VictronMqttEntity, SelectEntity):
+    """Remote panel mode select."""
+
+    _attr_name = "Remote Panel Mode"
+    _attr_options = list(PANEL_MODES)
+    _attr_icon = "mdi:transmission-tower-export"
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        super().__init__(bridge)
+        self._attr_unique_id = f"{bridge.topic_root}_remote_panel_mode"
+
+    @property
+    def current_option(self) -> str | None:
+        return self.bridge.panel_mode
+
+    @property
+    def available(self) -> bool:
+        return bool(self.bridge.command_topic)
+
+    async def async_select_option(self, option: str) -> None:
+        await self.bridge.async_publish_command({"kind": "panel_state", "switch": option})

custom_components/victron_mk2_mqtt/sensor.py

@@ -0,0 +1,148 @@
+"""Sensor entities for Victron MK2 MQTT integration."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from dataclasses import dataclass
+from typing import Any
+
+from homeassistant.components.sensor import SensorEntity, SensorStateClass
+from homeassistant.const import (
+    EntityCategory,
+    PERCENTAGE,
+    UnitOfElectricCurrent,
+    UnitOfElectricPotential,
+    UnitOfFrequency,
+)
+from homeassistant.core import HomeAssistant
+
+from .const import DATA_BRIDGE, DOMAIN
+from .coordinator import VictronMqttBridge
+from .entity import VictronMqttEntity
+
+
+@dataclass(frozen=True)
+class MetricDescription:
+    """Description for a telemetry-backed sensor."""
+
+    key: str
+    name: str
+    value_fn: Callable[[VictronMqttBridge], Any]
+    unit: str | None = None
+    state_class: SensorStateClass | None = SensorStateClass.MEASUREMENT
+    entity_category: EntityCategory | None = None
+
+
+METRICS: tuple[MetricDescription, ...] = (
+    MetricDescription(
+        key="battery_voltage",
+        name="Battery Voltage",
+        value_fn=lambda bridge: bridge.metric_float("BatVoltage"),
+        unit=UnitOfElectricPotential.VOLT,
+    ),
+    MetricDescription(
+        key="battery_current",
+        name="Battery Current",
+        value_fn=lambda bridge: bridge.metric_float("BatCurrent"),
+        unit=UnitOfElectricCurrent.AMPERE,
+    ),
+    MetricDescription(
+        key="battery_charge",
+        name="Battery Charge",
+        value_fn=lambda bridge: (
+            bridge.metric_float("ChargeState") * 100.0
+            if bridge.metric_float("ChargeState") is not None
+            else None
+        ),
+        unit=PERCENTAGE,
+    ),
+    MetricDescription(
+        key="input_voltage",
+        name="Input Voltage",
+        value_fn=lambda bridge: bridge.metric_float("InVoltage"),
+        unit=UnitOfElectricPotential.VOLT,
+    ),
+    MetricDescription(
+        key="input_current",
+        name="Input Current",
+        value_fn=lambda bridge: bridge.metric_float("InCurrent"),
+        unit=UnitOfElectricCurrent.AMPERE,
+    ),
+    MetricDescription(
+        key="input_frequency",
+        name="Input Frequency",
+        value_fn=lambda bridge: bridge.metric_float("InFrequency"),
+        unit=UnitOfFrequency.HERTZ,
+    ),
+    MetricDescription(
+        key="output_voltage",
+        name="Output Voltage",
+        value_fn=lambda bridge: bridge.metric_float("OutVoltage"),
+        unit=UnitOfElectricPotential.VOLT,
+    ),
+    MetricDescription(
+        key="output_current",
+        name="Output Current",
+        value_fn=lambda bridge: bridge.metric_float("OutCurrent"),
+        unit=UnitOfElectricCurrent.AMPERE,
+    ),
+    MetricDescription(
+        key="output_frequency",
+        name="Output Frequency",
+        value_fn=lambda bridge: bridge.metric_float("OutFrequency"),
+        unit=UnitOfFrequency.HERTZ,
+    ),
+    MetricDescription(
+        key="input_power",
+        name="Input Power",
+        value_fn=lambda bridge: _product(bridge.metric_float("InVoltage"), bridge.metric_float("InCurrent")),
+        unit="VA",
+    ),
+    MetricDescription(
+        key="output_power",
+        name="Output Power",
+        value_fn=lambda bridge: _product(bridge.metric_float("OutVoltage"), bridge.metric_float("OutCurrent")),
+        unit="VA",
+    ),
+    MetricDescription(
+        key="last_command_error",
+        name="Last Command Error",
+        value_fn=lambda bridge: bridge.last_error,
+        state_class=None,
+        entity_category=EntityCategory.DIAGNOSTIC,
+    ),
+)
+
+
+def _product(a: float | None, b: float | None) -> float | None:
+    if a is None or b is None:
+        return None
+    return a * b
+
+
+async def async_setup_platform(
+    hass: HomeAssistant,
+    config: dict[str, Any],
+    async_add_entities,
+    discovery_info: dict[str, Any] | None = None,
+) -> None:
+    """Set up Victron telemetry sensors."""
+    bridge: VictronMqttBridge = hass.data[DOMAIN][DATA_BRIDGE]
+    async_add_entities(VictronMetricSensor(bridge, metric) for metric in METRICS)
+
+
+class VictronMetricSensor(VictronMqttEntity, SensorEntity):
+    """Generic telemetry sensor."""
+
+    def __init__(self, bridge: VictronMqttBridge, description: MetricDescription) -> None:
+        super().__init__(bridge)
+        self.entity_description = description
+        self._attr_unique_id = f"{bridge.topic_root}_{description.key}"
+        self._attr_name = description.name
+        self._attr_native_unit_of_measurement = description.unit
+        self._attr_state_class = description.state_class
+        self._attr_entity_category = description.entity_category
+
+    @property
+    def native_value(self):
+        return self.entity_description.value_fn(self.bridge)

custom_components/victron_mk2_mqtt/services.yaml

@@ -0,0 +1,75 @@
+set_remote_panel_state:
+  name: Set Remote Panel State
+  description: Set the remote panel mode and/or AC input current limit over MQTT.
+  fields:
+    mode:
+      name: Mode
+      description: Remote panel mode.
+      required: false
+      selector:
+        select:
+          mode: dropdown
+          options:
+            - charger_only
+            - inverter_only
+            - on
+            - off
+    current_limit:
+      name: Current Limit
+      description: AC input current limit in amps.
+      required: false
+      selector:
+        number:
+          min: 0
+          max: 100
+          step: 0.1
+          unit_of_measurement: A
+          mode: box
+
+set_ess_control:
+  name: Set ESS Control
+  description: Set ESS-style control values compatible with guide CGwacs paths.
+  fields:
+    ess_setpoint:
+      name: ESS Setpoint
+      description: AC power setpoint in watts. Positive charges/imports, negative discharges/exports.
+      required: false
+      selector:
+        number:
+          min: -20000
+          max: 20000
+          step: 1
+          unit_of_measurement: W
+          mode: box
+    ess_max_charge_power:
+      name: ESS Max Charge Power
+      description: Maximum allowed charge/import power in watts.
+      required: false
+      selector:
+        number:
+          min: 0
+          max: 20000
+          step: 1
+          unit_of_measurement: W
+          mode: box
+    ess_max_discharge_power:
+      name: ESS Max Discharge Power
+      description: Maximum allowed discharge/export power in watts.
+      required: false
+      selector:
+        number:
+          min: 0
+          max: 20000
+          step: 1
+          unit_of_measurement: W
+          mode: box
+    ess_mode:
+      name: ESS Mode
+      description: ESS battery life mode value (10 optimized, 9 keep charged).
+      required: false
+      selector:
+        number:
+          min: 9
+          max: 10
+          step: 1
+          mode: box

custom_components/victron_mk2_mqtt/switch.py

@@ -0,0 +1,76 @@
+"""Switch entities for Victron MK2 MQTT integration."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from homeassistant.components.switch import SwitchEntity
+from homeassistant.core import HomeAssistant
+
+from .const import DATA_BRIDGE, DOMAIN
+from .coordinator import VictronMqttBridge
+from .entity import VictronMqttEntity
+
+
+async def async_setup_platform(
+    hass: HomeAssistant,
+    config: dict[str, Any],
+    async_add_entities,
+    discovery_info: dict[str, Any] | None = None,
+) -> None:
+    """Set up Victron switch entities."""
+    bridge: VictronMqttBridge = hass.data[DOMAIN][DATA_BRIDGE]
+    entities: list[SwitchEntity] = [VictronRemotePanelStandbySwitch(bridge)]
+    if bridge.venus_guide_compat:
+        entities.append(VictronESSOptimizedModeSwitch(bridge))
+    async_add_entities(entities)
+
+
+class VictronRemotePanelStandbySwitch(VictronMqttEntity, SwitchEntity):
+    """Remote panel standby switch."""
+
+    _attr_name = "Remote Panel Standby"
+    _attr_icon = "mdi:power-sleep"
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        super().__init__(bridge)
+        self._attr_unique_id = f"{bridge.topic_root}_remote_panel_standby"
+
+    @property
+    def is_on(self) -> bool:
+        return bool(self.bridge.standby)
+
+    @property
+    def available(self) -> bool:
+        return bool(self.bridge.command_topic)
+
+    async def async_turn_on(self, **kwargs: Any) -> None:
+        await self.bridge.async_publish_command({"kind": "standby", "standby": True})
+
+    async def async_turn_off(self, **kwargs: Any) -> None:
+        await self.bridge.async_publish_command({"kind": "standby", "standby": False})
+
+
+class VictronESSOptimizedModeSwitch(VictronMqttEntity, SwitchEntity):
+    """Guide-compatible ESS optimized mode switch."""
+
+    _attr_name = "ESS Optimized Mode"
+    _attr_icon = "mdi:battery-sync"
+
+    def __init__(self, bridge: VictronMqttBridge) -> None:
+        super().__init__(bridge)
+        self._attr_unique_id = f"{bridge.topic_root}_ess_optimized_mode"
+
+    @property
+    def is_on(self) -> bool:
+        return self.bridge.ess_mode == 10
+
+    @property
+    def available(self) -> bool:
+        return bool(self.bridge.command_topic and self.bridge.venus_guide_compat)
+
+    async def async_turn_on(self, **kwargs: Any) -> None:
+        await self.bridge.async_publish_command({"kind": "ess_mode", "value": 10})
+
+    async def async_turn_off(self, **kwargs: Any) -> None:
+        await self.bridge.async_publish_command({"kind": "ess_mode", "value": 9})

go.mod

@@ -1,4 +1,4 @@
-module invertergui
+module git.coadcorp.com/nathan/invertergui
 
 go 1.26
 
@@ -22,6 +22,7 @@ require (
 	github.com/prometheus/client_model v0.6.2 // indirect
 	github.com/prometheus/common v0.67.5 // indirect
 	github.com/prometheus/procfs v0.19.2 // indirect
+	github.com/rogpeppe/go-internal v1.14.1 // indirect
 	go.yaml.in/yaml/v2 v2.4.3 // indirect
 	golang.org/x/net v0.50.0 // indirect
 	golang.org/x/sync v0.19.0 // indirect

go.sum

@@ -1,93 +1,60 @@
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
-github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
-github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
 github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/eclipse/paho.mqtt.golang v1.4.3 h1:2kwcUGn8seMUfWndX0hGbvH8r7crgcJguQNCyp70xik=
-github.com/eclipse/paho.mqtt.golang v1.4.3/go.mod h1:CSYvoAlsMkhYOXh/oKyxa8EcBci6dVkLCbo5tTC1RIE=
 github.com/eclipse/paho.mqtt.golang v1.5.1 h1:/VSOv3oDLlpqR2Epjn1Q7b2bSTplJIeV2ISgCl2W7nE=
 github.com/eclipse/paho.mqtt.golang v1.5.1/go.mod h1:1/yJCneuyOoCOzKSsOTUc0AJfpsItBGWvYpBLimhArU=
-github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
-github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
-github.com/gorilla/websocket v1.5.1 h1:gmztn0JnHVt9JZquRuzLw3g4wouNVzKL15iLr/zn/QY=
+github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
-github.com/gorilla/websocket v1.5.1/go.mod h1:x3kM2JMyaluk02fnUJpQuwD2dCS5NDG2ZHL0uE0tcaY=
 github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
 github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
-github.com/jessevdk/go-flags v1.5.0 h1:1jKYvbxEjfUl0fmqTCOfonvskHHXMjBySTLW4y9LFvc=
-github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4=
 github.com/jessevdk/go-flags v1.6.1 h1:Cvu5U8UGrLay1rZfv/zP7iLpSHGUZ/Ou68T0iX1bBK4=
 github.com/jessevdk/go-flags v1.6.1/go.mod h1:Mk8T1hIAWpOiJiHa9rJASDK2UGWji0EuPGBnNLMooyc=
+github.com/klauspost/compress v1.18.0 h1:c/Cqfb0r+Yi+JtIEq73FWXVkRonBlf0CRNYc8Zttxdo=
+github.com/klauspost/compress v1.18.0/go.mod h1:2Pp+KzxcywXVXMr50+X0Q/Lsb43OQHYWRCY2AiWywWQ=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
+github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/prometheus/client_golang v1.19.0 h1:ygXvpU1AoN1MhdzckN+PyD9QJOSD4x7kmXYlnfbA6JU=
-github.com/prometheus/client_golang v1.19.0/go.mod h1:ZRM9uEAypZakd+q/x7+gmsvXdURP+DABIEIjnmDdp+k=
 github.com/prometheus/client_golang v1.23.2 h1:Je96obch5RDVy3FDMndoUsjAhG5Edi49h0RJWRi/o0o=
 github.com/prometheus/client_golang v1.23.2/go.mod h1:Tb1a6LWHB3/SPIzCoaDXI4I8UHKeFTEQ1YCr+0Gyqmg=
-github.com/prometheus/client_model v0.6.0 h1:k1v3CzpSRUTrKMppY35TLwPvxHqBu0bYgxZzqGIgaos=
-github.com/prometheus/client_model v0.6.0/go.mod h1:NTQHnmxFpouOD0DpvP4XujX3CdOAGQPoaGhyTchlyt8=
 github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk=
 github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE=
-github.com/prometheus/common v0.50.0 h1:YSZE6aa9+luNa2da6/Tik0q0A5AbR+U003TItK57CPQ=
-github.com/prometheus/common v0.50.0/go.mod h1:wHFBCEVWVmHMUpg7pYcOm2QUR/ocQdYSJVQJKnHc3xQ=
 github.com/prometheus/common v0.67.5 h1:pIgK94WWlQt1WLwAC5j2ynLaBRDiinoAb86HZHTUGI4=
 github.com/prometheus/common v0.67.5/go.mod h1:SjE/0MzDEEAyrdr5Gqc6G+sXI67maCxzaT3A2+HqjUw=
-github.com/prometheus/procfs v0.13.0 h1:GqzLlQyfsPbaEHaQkO7tbDlriv/4o5Hudv6OXHGKX7o=
-github.com/prometheus/procfs v0.13.0/go.mod h1:cd4PFCR54QLnGKPaKGA6l+cfuNXtht43ZKY6tow0Y1g=
 github.com/prometheus/procfs v0.19.2 h1:zUMhqEW66Ex7OXIiDkll3tl9a1ZdilUOd/F6ZXw4Vws=
 github.com/prometheus/procfs v0.19.2/go.mod h1:M0aotyiemPhBCM0z5w87kL22CxfcH05ZpYlu+b4J7mw=
-github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
+github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
-github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
+github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
-github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
-github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/sirupsen/logrus v1.9.4 h1:TsZE7l11zFCLZnZ+teH4Umoq5BhEIfIzfRDZ1Uzql2w=
 github.com/sirupsen/logrus v1.9.4/go.mod h1:ftWc9WdOfJ0a92nsE2jF5u5ZwH8Bv2zdeOC42RjbV2g=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
-github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
 github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07 h1:UyzmZLoiDWMRywV4DUYb9Fbt8uiOSooupjTq10vpvnU=
 github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07/go.mod h1:kDXzergiv9cbyO7IOYJZWg1U88JhDg3PB6klq9Hg2pA=
+go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
+go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
 go.yaml.in/yaml/v2 v2.4.3 h1:6gvOSjQoTB3vt1l+CU+tSyi/HOjfOjRLJ4YwYZGwRO0=
 go.yaml.in/yaml/v2 v2.4.3/go.mod h1:zSxWcmIDjOzPXpjlTTbAsKokqkDNAVtZO0WOMiT90s8=
-golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
-golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
 golang.org/x/net v0.50.0 h1:ucWh9eiCGyDR3vtzso0WMQinm2Dnt8cFMuQa9K33J60=
 golang.org/x/net v0.50.0/go.mod h1:UgoSli3F/pBgdJBHCTc+tp3gmrU4XswgGRgtnwWTfyM=
-golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
-golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4=
 golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
-golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
-golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
 golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
-google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
-google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
 google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

homeassistant/dashboards/invertergui_mqtt_dashboard.yaml

@@ -0,0 +1,132 @@
+title: Victron Inverter MQTT
+views:
+  - title: Inverter
+    path: victron-inverter
+    icon: mdi:flash
+    badges:
+      - entity: binary_sensor.victron_online
+      - entity: binary_sensor.victron_data_valid
+      - entity: sensor.victron_last_command_status
+    cards:
+      - type: vertical-stack
+        cards:
+          - type: markdown
+            content: |
+              ## Remote Panel Control
+              Mode and current limit are published together over MQTT, matching `set_remote_panel_state`.
+          - type: entities
+            title: Current Remote State
+            state_color: true
+            show_header_toggle: false
+            entities:
+              - entity: select.victron_remote_panel_mode
+                name: Mode
+              - entity: number.victron_remote_panel_current_limit
+                name: AC Input Current Limit
+              - entity: switch.victron_remote_panel_standby
+                name: Prevent Sleep While Off
+              - entity: sensor.victron_last_command_error
+                name: Last Command Error
+          - type: entities
+            title: Apply Mode + Current Limit
+            show_header_toggle: false
+            entities:
+              - entity: input_select.victron_remote_panel_mode_target
+                name: Target Mode
+              - entity: input_number.victron_remote_panel_current_limit_target
+                name: Target Current Limit
+              - entity: script.victron_mqtt_set_remote_panel_state
+                name: Apply Mode + Current Limit
+          - type: entities
+            title: Apply Standby
+            show_header_toggle: false
+            entities:
+              - entity: input_boolean.victron_remote_panel_standby_target
+                name: Target Standby
+              - entity: script.victron_mqtt_set_remote_panel_standby
+                name: Apply Standby
+          - type: entities
+            title: ESS Guide-Style Control (MQTT)
+            show_header_toggle: false
+            entities:
+              - entity: number.victron_ess_grid_setpoint
+                name: Grid Setpoint (W)
+              - entity: number.victron_ess_max_charge_power
+                name: Max Charge Power (W)
+              - entity: number.victron_ess_max_discharge_power
+                name: Max Discharge Power (W)
+              - entity: switch.victron_ess_optimized_mode
+                name: Optimized Mode (10 on / 9 off)
+
+      - type: grid
+        columns: 3
+        square: false
+        cards:
+          - type: entities
+            title: Output
+            show_header_toggle: false
+            entities:
+              - entity: sensor.victron_output_current
+                name: Output Current
+              - entity: sensor.victron_output_voltage
+                name: Output Voltage
+              - entity: sensor.victron_output_frequency
+                name: Output Frequency
+              - entity: sensor.victron_output_power
+                name: Output Power
+          - type: entities
+            title: Input
+            show_header_toggle: false
+            entities:
+              - entity: sensor.victron_input_current
+                name: Input Current
+              - entity: sensor.victron_input_voltage
+                name: Input Voltage
+              - entity: sensor.victron_input_frequency
+                name: Input Frequency
+              - entity: sensor.victron_input_power
+                name: Input Power
+              - entity: sensor.victron_input_minus_output_power
+                name: Input - Output Power
+          - type: entities
+            title: Battery
+            show_header_toggle: false
+            entities:
+              - entity: sensor.victron_battery_current
+                name: Battery Current
+              - entity: sensor.victron_battery_voltage
+                name: Battery Voltage
+              - entity: sensor.victron_battery_power
+                name: Battery Power
+              - entity: sensor.victron_battery_charge
+                name: Battery Charge
+
+      - type: entities
+        title: LED Status
+        show_header_toggle: false
+        entities:
+          - entity: sensor.victron_led_mains
+            name: Mains
+          - entity: sensor.victron_led_absorb
+            name: Absorb
+          - entity: sensor.victron_led_bulk
+            name: Bulk
+          - entity: sensor.victron_led_float
+            name: Float
+          - entity: sensor.victron_led_inverter
+            name: Inverter
+          - entity: sensor.victron_led_overload
+            name: Overload
+          - entity: sensor.victron_led_low_battery
+            name: Low Battery
+          - entity: sensor.victron_led_over_temp
+            name: Over Temperature
+
+      - type: history-graph
+        title: Power (Last 2 Hours)
+        hours_to_show: 2
+        refresh_interval: 60
+        entities:
+          - entity: sensor.victron_input_power
+          - entity: sensor.victron_output_power
+          - entity: sensor.victron_battery_power

homeassistant/packages/invertergui_mqtt.yaml

@@ -0,0 +1,401 @@
+# MQTT-only Home Assistant package for invertergui.
+# This avoids duplicate entities from MQTT auto-discovery/custom integration.
+#
+# Requirements:
+# - invertergui started with MQTT publishing enabled.
+# - invertergui MQTT discovery disabled (`--mqtt.ha.enabled=false`) when using this package.
+# - for guide-style ESS controls below, enable:
+#   `MQTT_VENUS_ENABLED=true`
+#   `MQTT_VENUS_GUIDE_COMPAT=true`
+#   `MQTT_VENUS_TOPIC_PREFIX=victron`
+#   `MQTT_VENUS_PORTAL_ID=invertergui`
+
+mqtt:
+  sensor:
+    - name: Victron Battery Voltage
+      unique_id: invertergui_mqtt_battery_voltage
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.BatVoltage }}"
+      unit_of_measurement: V
+      device_class: voltage
+      state_class: measurement
+    - name: Victron Battery Current
+      unique_id: invertergui_mqtt_battery_current
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.BatCurrent }}"
+      unit_of_measurement: A
+      device_class: current
+      state_class: measurement
+    - name: Victron Battery Charge
+      unique_id: invertergui_mqtt_battery_charge
+      state_topic: invertergui/updates
+      value_template: "{{ ((value_json.ChargeState | float(0)) * 100) | round(1) }}"
+      unit_of_measurement: "%"
+      device_class: battery
+      state_class: measurement
+    - name: Victron Input Voltage
+      unique_id: invertergui_mqtt_input_voltage
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.InVoltage }}"
+      unit_of_measurement: V
+      device_class: voltage
+      state_class: measurement
+    - name: Victron Input Current
+      unique_id: invertergui_mqtt_input_current
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.InCurrent }}"
+      unit_of_measurement: A
+      device_class: current
+      state_class: measurement
+    - name: Victron Input Frequency
+      unique_id: invertergui_mqtt_input_frequency
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.InFrequency }}"
+      unit_of_measurement: Hz
+      device_class: frequency
+      state_class: measurement
+    - name: Victron Output Voltage
+      unique_id: invertergui_mqtt_output_voltage
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.OutVoltage }}"
+      unit_of_measurement: V
+      device_class: voltage
+      state_class: measurement
+    - name: Victron Output Current
+      unique_id: invertergui_mqtt_output_current
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.OutCurrent }}"
+      unit_of_measurement: A
+      device_class: current
+      state_class: measurement
+    - name: Victron Output Frequency
+      unique_id: invertergui_mqtt_output_frequency
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.OutFrequency }}"
+      unit_of_measurement: Hz
+      device_class: frequency
+      state_class: measurement
+    - name: Victron Input Power
+      unique_id: invertergui_mqtt_input_power
+      state_topic: invertergui/updates
+      value_template: "{{ ((value_json.InVoltage | float(0)) * (value_json.InCurrent | float(0))) | round(1) }}"
+      unit_of_measurement: VA
+      state_class: measurement
+    - name: Victron Output Power
+      unique_id: invertergui_mqtt_output_power
+      state_topic: invertergui/updates
+      value_template: "{{ ((value_json.OutVoltage | float(0)) * (value_json.OutCurrent | float(0))) | round(1) }}"
+      unit_of_measurement: VA
+      state_class: measurement
+    - name: Victron Last Command Status
+      unique_id: invertergui_mqtt_last_command_status
+      state_topic: invertergui/settings/status
+      value_template: "{{ value_json.status | default('unknown') }}"
+      icon: mdi:message-alert-outline
+    - name: Victron Last Command Error
+      unique_id: invertergui_mqtt_last_command_error
+      state_topic: invertergui/settings/status
+      value_template: >-
+        {% if value_json.status == 'error' %}
+          {{ value_json.error | default('unknown error') }}
+        {% else %}
+          none
+        {% endif %}
+      icon: mdi:alert-circle-outline
+    - name: Victron LED Mains
+      unique_id: invertergui_mqtt_led_mains
+      state_topic: invertergui/updates
+      value_template: >-
+        {% set leds = value_json.LEDs | default({}) %}
+        {% set v = leds['0'] | default(0) | int(0) %}
+        {% if v == 1 %}on{% elif v == 2 %}blink{% else %}off{% endif %}
+      icon: mdi:transmission-tower
+    - name: Victron LED Absorb
+      unique_id: invertergui_mqtt_led_absorb
+      state_topic: invertergui/updates
+      value_template: >-
+        {% set leds = value_json.LEDs | default({}) %}
+        {% set v = leds['1'] | default(0) | int(0) %}
+        {% if v == 1 %}on{% elif v == 2 %}blink{% else %}off{% endif %}
+      icon: mdi:water-outline
+    - name: Victron LED Bulk
+      unique_id: invertergui_mqtt_led_bulk
+      state_topic: invertergui/updates
+      value_template: >-
+        {% set leds = value_json.LEDs | default({}) %}
+        {% set v = leds['2'] | default(0) | int(0) %}
+        {% if v == 1 %}on{% elif v == 2 %}blink{% else %}off{% endif %}
+      icon: mdi:battery-plus
+    - name: Victron LED Float
+      unique_id: invertergui_mqtt_led_float
+      state_topic: invertergui/updates
+      value_template: >-
+        {% set leds = value_json.LEDs | default({}) %}
+        {% set v = leds['3'] | default(0) | int(0) %}
+        {% if v == 1 %}on{% elif v == 2 %}blink{% else %}off{% endif %}
+      icon: mdi:battery-heart-variant
+    - name: Victron LED Inverter
+      unique_id: invertergui_mqtt_led_inverter
+      state_topic: invertergui/updates
+      value_template: >-
+        {% set leds = value_json.LEDs | default({}) %}
+        {% set v = leds['4'] | default(0) | int(0) %}
+        {% if v == 1 %}on{% elif v == 2 %}blink{% else %}off{% endif %}
+      icon: mdi:power-plug
+    - name: Victron LED Overload
+      unique_id: invertergui_mqtt_led_overload
+      state_topic: invertergui/updates
+      value_template: >-
+        {% set leds = value_json.LEDs | default({}) %}
+        {% set v = leds['5'] | default(0) | int(0) %}
+        {% if v == 1 %}on{% elif v == 2 %}blink{% else %}off{% endif %}
+      icon: mdi:alert-octagon
+    - name: Victron LED Low Battery
+      unique_id: invertergui_mqtt_led_low_battery
+      state_topic: invertergui/updates
+      value_template: >-
+        {% set leds = value_json.LEDs | default({}) %}
+        {% set v = leds['6'] | default(0) | int(0) %}
+        {% if v == 1 %}on{% elif v == 2 %}blink{% else %}off{% endif %}
+      icon: mdi:battery-alert-variant-outline
+    - name: Victron LED Over Temp
+      unique_id: invertergui_mqtt_led_over_temp
+      state_topic: invertergui/updates
+      value_template: >-
+        {% set leds = value_json.LEDs | default({}) %}
+        {% set v = leds['7'] | default(0) | int(0) %}
+        {% if v == 1 %}on{% elif v == 2 %}blink{% else %}off{% endif %}
+      icon: mdi:thermometer-alert
+
+  binary_sensor:
+    - name: Victron Online
+      unique_id: invertergui_mqtt_online
+      state_topic: invertergui/updates
+      value_template: "ON"
+      payload_on: "ON"
+      payload_off: "OFF"
+      expire_after: 120
+      device_class: connectivity
+    - name: Victron Data Valid
+      unique_id: invertergui_mqtt_data_valid
+      state_topic: invertergui/updates
+      value_template: "{{ value_json.Valid }}"
+      payload_on: "true"
+      payload_off: "false"
+      entity_category: diagnostic
+
+  select:
+    - name: Victron Remote Panel Mode
+      unique_id: invertergui_mqtt_remote_panel_mode
+      state_topic: invertergui/homeassistant/remote_panel_mode/state
+      command_topic: invertergui/settings/set
+      command_template: '{"kind":"panel_state","switch":"{{ value }}"}'
+      options:
+        - charger_only
+        - inverter_only
+        - on
+        - off
+      icon: mdi:transmission-tower-export
+
+  number:
+    - name: Victron Remote Panel Current Limit
+      unique_id: invertergui_mqtt_remote_panel_current_limit
+      state_topic: invertergui/homeassistant/remote_panel_current_limit/state
+      command_topic: invertergui/settings/set
+      command_template: '{"kind":"panel_state","current_limit":{{ value | float(0) }}}'
+      unit_of_measurement: A
+      device_class: current
+      mode: box
+      min: 0
+      max: 100
+      step: 0.1
+      icon: mdi:current-ac
+    - name: Victron ESS Grid Setpoint
+      unique_id: invertergui_mqtt_ess_grid_setpoint
+      state_topic: victron/N/invertergui/settings/0/Settings/CGwacs/AcPowerSetPoint
+      value_template: "{{ value_json.value | float(0) }}"
+      command_topic: victron/W/invertergui/settings/0/Settings/CGwacs/AcPowerSetPoint
+      command_template: '{"value":{{ value | float(0) | round(0) }}}'
+      unit_of_measurement: W
+      mode: box
+      min: -20000
+      max: 20000
+      step: 1
+      icon: mdi:transmission-tower-export
+    - name: Victron ESS Max Charge Power
+      unique_id: invertergui_mqtt_ess_max_charge_power
+      state_topic: victron/N/invertergui/settings/0/Settings/CGwacs/MaxChargePower
+      value_template: "{{ value_json.value | float(0) }}"
+      command_topic: victron/W/invertergui/settings/0/Settings/CGwacs/MaxChargePower
+      command_template: '{"value":{{ value | float(0) | round(0) }}}'
+      unit_of_measurement: W
+      mode: box
+      min: 0
+      max: 20000
+      step: 1
+      icon: mdi:battery-plus
+    - name: Victron ESS Max Discharge Power
+      unique_id: invertergui_mqtt_ess_max_discharge_power
+      state_topic: victron/N/invertergui/settings/0/Settings/CGwacs/MaxDischargePower
+      value_template: "{{ value_json.value | float(0) }}"
+      command_topic: victron/W/invertergui/settings/0/Settings/CGwacs/MaxDischargePower
+      command_template: '{"value":{{ value | float(0) | round(0) }}}'
+      unit_of_measurement: W
+      mode: box
+      min: 0
+      max: 20000
+      step: 1
+      icon: mdi:battery-minus
+
+  switch:
+    - name: Victron Remote Panel Standby
+      unique_id: invertergui_mqtt_remote_panel_standby
+      state_topic: invertergui/homeassistant/remote_panel_standby/state
+      command_topic: invertergui/settings/set
+      payload_on: '{"kind":"standby","standby":true}'
+      payload_off: '{"kind":"standby","standby":false}'
+      state_on: "ON"
+      state_off: "OFF"
+      icon: mdi:power-sleep
+    - name: Victron ESS Optimized Mode
+      unique_id: invertergui_mqtt_ess_optimized_mode
+      state_topic: victron/N/invertergui/settings/0/Settings/CGwacs/BatteryLife/State
+      value_template: "{{ value_json.value | int(9) }}"
+      command_topic: victron/W/invertergui/settings/0/Settings/CGwacs/BatteryLife/State
+      payload_on: '{"value":10}'
+      payload_off: '{"value":9}'
+      state_on: "10"
+      state_off: "9"
+      icon: mdi:battery-sync
+
+input_select:
+  victron_remote_panel_mode_target:
+    name: Victron Target Mode
+    options:
+      - charger_only
+      - inverter_only
+      - on
+      - off
+    icon: mdi:transmission-tower-export
+
+input_number:
+  victron_remote_panel_current_limit_target:
+    name: Victron Target Current Limit
+    min: 0
+    max: 100
+    step: 0.1
+    unit_of_measurement: A
+    mode: box
+    icon: mdi:current-ac
+
+input_boolean:
+  victron_remote_panel_standby_target:
+    name: Victron Target Standby
+    icon: mdi:power-sleep
+
+script:
+  victron_mqtt_set_remote_panel_state:
+    alias: Victron MQTT Set Remote Panel State
+    description: Set panel mode and current limit in one MQTT command.
+    mode: single
+    icon: mdi:send
+    sequence:
+      - service: mqtt.publish
+        data:
+          topic: invertergui/settings/set
+          qos: 1
+          payload: >-
+            {"kind":"panel_state","switch":"{{ states('input_select.victron_remote_panel_mode_target') }}","current_limit":{{ states('input_number.victron_remote_panel_current_limit_target') | float(0) | round(1) }}}
+
+  victron_mqtt_set_remote_panel_standby:
+    alias: Victron MQTT Set Remote Panel Standby
+    description: Set standby state from helper input.
+    mode: single
+    icon: mdi:send-circle
+    sequence:
+      - service: mqtt.publish
+        data:
+          topic: invertergui/settings/set
+          qos: 1
+          payload: >-
+            {"kind":"standby","standby":{% if is_state('input_boolean.victron_remote_panel_standby_target', 'on') %}true{% else %}false{% endif %}}
+
+template:
+  - sensor:
+      - name: Victron Battery Power
+        unique_id: invertergui_mqtt_battery_power
+        unit_of_measurement: W
+        state_class: measurement
+        icon: mdi:battery-charging
+        state: >-
+          {{ ((states('sensor.victron_battery_voltage') | float(0)) * (states('sensor.victron_battery_current') | float(0))) | round(1) }}
+      - name: Victron Input Minus Output Power
+        unique_id: invertergui_mqtt_input_minus_output_power
+        unit_of_measurement: VA
+        state_class: measurement
+        icon: mdi:flash-triangle
+        state: >-
+          {{ (states('sensor.victron_input_power') | float(0) - states('sensor.victron_output_power') | float(0)) | round(1) }}
+
+automation:
+  - id: victron_mqtt_sync_target_mode
+    alias: Victron MQTT Sync Mode Target
+    trigger:
+      - platform: state
+        entity_id: select.victron_remote_panel_mode
+      - platform: homeassistant
+        event: start
+    condition:
+      - condition: template
+        value_template: >-
+          {{ states('select.victron_remote_panel_mode') in ['charger_only', 'inverter_only', 'on', 'off'] }}
+    action:
+      - service: input_select.select_option
+        target:
+          entity_id: input_select.victron_remote_panel_mode_target
+        data:
+          option: "{{ states('select.victron_remote_panel_mode') }}"
+
+  - id: victron_mqtt_sync_target_current_limit
+    alias: Victron MQTT Sync Current Limit Target
+    trigger:
+      - platform: state
+        entity_id: number.victron_remote_panel_current_limit
+      - platform: homeassistant
+        event: start
+    condition:
+      - condition: template
+        value_template: >-
+          {{ states('number.victron_remote_panel_current_limit') not in ['unknown', 'unavailable'] }}
+    action:
+      - service: input_number.set_value
+        target:
+          entity_id: input_number.victron_remote_panel_current_limit_target
+        data:
+          value: "{{ states('number.victron_remote_panel_current_limit') | float(0) }}"
+
+  - id: victron_mqtt_sync_target_standby
+    alias: Victron MQTT Sync Standby Target
+    trigger:
+      - platform: state
+        entity_id: switch.victron_remote_panel_standby
+      - platform: homeassistant
+        event: start
+    action:
+      - choose:
+          - conditions:
+              - condition: state
+                entity_id: switch.victron_remote_panel_standby
+                state: "on"
+            sequence:
+              - service: input_boolean.turn_on
+                target:
+                  entity_id: input_boolean.victron_remote_panel_standby_target
+          - conditions:
+              - condition: state
+                entity_id: switch.victron_remote_panel_standby
+                state: "off"
+            sequence:
+              - service: input_boolean.turn_off
+                target:
+                  entity_id: input_boolean.victron_remote_panel_standby_target

mk2core/core.go

@@ -1,9 +1,12 @@
 package mk2core
 
 import (
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
+	"github.com/sirupsen/logrus"
 )
 
+var log = logrus.WithField("ctx", "inverter-gui-core")
+
 type Core struct {
 	mk2driver.Mk2
 	plugins  map[*subscription]bool
@@ -16,6 +19,7 @@ func NewCore(m mk2driver.Mk2) *Core {
 		register: make(chan *subscription, 255),
 		plugins:  map[*subscription]bool{},
 	}
+	log.Info("Core initialized")
 	go core.run()
 	return core
 }
@@ -25,6 +29,7 @@ func (c *Core) NewSubscription() mk2driver.Mk2 {
 		send: make(chan *mk2driver.Mk2Info),
 	}
 	c.register <- sub
+	log.Debug("New plugin subscription registered")
 	return sub
 }
 
@@ -33,11 +38,13 @@ func (c *Core) run() {
 		select {
 		case r := <-c.register:
 			c.plugins[r] = true
+			log.WithField("subscribers", len(c.plugins)).Debug("Subscription added")
 		case e := <-c.C():
 			for plugin := range c.plugins {
 				select {
 				case plugin.send <- e:
 				default:
+					log.WithField("subscribers", len(c.plugins)).Warn("Dropping update for a slow subscriber")
 				}
 			}
 		}

mk2driver/managed_writer.go

@@ -0,0 +1,232 @@
+package mk2driver
+
+import (
+	"errors"
+	"fmt"
+	"sort"
+	"sync"
+	"time"
+)
+
+type WriterProfile string
+
+const (
+	WriterProfileNormal      WriterProfile = "normal"
+	WriterProfileMaintenance WriterProfile = "maintenance"
+	WriterProfileReadOnly    WriterProfile = "read_only"
+)
+
+type WriterPolicy struct {
+	Profile               WriterProfile
+	MaxCurrentLimitA      *float64
+	ModeChangeMinInterval time.Duration
+	LockoutWindow         time.Duration
+	AllowedPanelStates    map[PanelSwitchState]struct{}
+}
+
+type CommandEvent struct {
+	Timestamp time.Time     `json:"timestamp"`
+	Source    CommandSource `json:"source"`
+	Kind      string        `json:"kind"`
+	Allowed   bool          `json:"allowed"`
+	Error     string        `json:"error,omitempty"`
+}
+
+type ManagedWriter struct {
+	writer SettingsWriter
+	policy WriterPolicy
+
+	mu             sync.Mutex
+	lastModeChange time.Time
+	lockoutUntil   time.Time
+	events         []CommandEvent
+}
+
+var _ SettingsWriter = (*ManagedWriter)(nil)
+var _ SourceAwareSettingsWriter = (*ManagedWriter)(nil)
+
+func NewManagedWriter(writer SettingsWriter, policy WriterPolicy) *ManagedWriter {
+	if policy.Profile == "" {
+		policy.Profile = WriterProfileNormal
+	}
+	return &ManagedWriter{
+		writer: writer,
+		policy: policy,
+		events: make([]CommandEvent, 0, 100),
+	}
+}
+
+func (m *ManagedWriter) WriteRAMVar(id uint16, value int16) error {
+	return m.WriteRAMVarWithSource(CommandSourceUnknown, id, value)
+}
+
+func (m *ManagedWriter) WriteSetting(id uint16, value int16) error {
+	return m.WriteSettingWithSource(CommandSourceUnknown, id, value)
+}
+
+func (m *ManagedWriter) SetPanelState(switchState PanelSwitchState, currentLimitA *float64) error {
+	return m.SetPanelStateWithSource(CommandSourceUnknown, switchState, currentLimitA)
+}
+
+func (m *ManagedWriter) SetStandby(enabled bool) error {
+	return m.SetStandbyWithSource(CommandSourceUnknown, enabled)
+}
+
+func (m *ManagedWriter) WriteRAMVarWithSource(source CommandSource, id uint16, value int16) error {
+	return m.apply(source, "write_ram_var", func() error {
+		if err := m.ensureProfileAllows("write_ram_var"); err != nil {
+			return err
+		}
+		return m.baseWriter().WriteRAMVar(id, value)
+	})
+}
+
+func (m *ManagedWriter) WriteSettingWithSource(source CommandSource, id uint16, value int16) error {
+	return m.apply(source, "write_setting", func() error {
+		if err := m.ensureProfileAllows("write_setting"); err != nil {
+			return err
+		}
+		return m.baseWriter().WriteSetting(id, value)
+	})
+}
+
+func (m *ManagedWriter) SetPanelStateWithSource(source CommandSource, switchState PanelSwitchState, currentLimitA *float64) error {
+	return m.apply(source, "set_panel_state", func() error {
+		if err := m.ensureProfileAllows("set_panel_state"); err != nil {
+			return err
+		}
+		if len(m.policy.AllowedPanelStates) > 0 {
+			if _, ok := m.policy.AllowedPanelStates[switchState]; !ok {
+				return fmt.Errorf(
+					"panel switch mode %s denied by allowlist policy; allowed modes: %s",
+					panelStateLabel(switchState),
+					stringsForAllowedPanelStates(m.policy.AllowedPanelStates),
+				)
+			}
+		}
+		if m.policy.MaxCurrentLimitA != nil && currentLimitA != nil && *currentLimitA > *m.policy.MaxCurrentLimitA {
+			return fmt.Errorf("current limit %.2fA exceeds configured policy max %.2fA", *currentLimitA, *m.policy.MaxCurrentLimitA)
+		}
+		if m.policy.Profile == WriterProfileMaintenance && switchState != PanelSwitchOff {
+			return errors.New("maintenance profile only allows panel switch off")
+		}
+		if m.policy.ModeChangeMinInterval > 0 && !m.lastModeChange.IsZero() && time.Since(m.lastModeChange) < m.policy.ModeChangeMinInterval {
+			return fmt.Errorf("mode change denied due to rate limit; wait %s", m.policy.ModeChangeMinInterval-time.Since(m.lastModeChange))
+		}
+		if err := m.baseWriter().SetPanelState(switchState, currentLimitA); err != nil {
+			return err
+		}
+		m.lastModeChange = time.Now().UTC()
+		return nil
+	})
+}
+
+func (m *ManagedWriter) SetStandbyWithSource(source CommandSource, enabled bool) error {
+	return m.apply(source, "set_standby", func() error {
+		if err := m.ensureProfileAllows("set_standby"); err != nil {
+			return err
+		}
+		return m.baseWriter().SetStandby(enabled)
+	})
+}
+
+func (m *ManagedWriter) History(limit int) []CommandEvent {
+	m.mu.Lock()
+	defer m.mu.Unlock()
+
+	if limit <= 0 || limit > len(m.events) {
+		limit = len(m.events)
+	}
+	out := make([]CommandEvent, limit)
+	if limit > 0 {
+		copy(out, m.events[len(m.events)-limit:])
+	}
+	return out
+}
+
+func (m *ManagedWriter) apply(source CommandSource, kind string, fn func() error) error {
+	m.mu.Lock()
+	defer m.mu.Unlock()
+
+	if m.writer == nil {
+		err := errors.New("settings writer is not available")
+		m.recordLocked(source, kind, false, err)
+		return err
+	}
+	if m.policy.LockoutWindow > 0 && time.Now().UTC().Before(m.lockoutUntil) {
+		err := fmt.Errorf("command denied during lockout window until %s", m.lockoutUntil.Format(time.RFC3339))
+		m.recordLocked(source, kind, false, err)
+		return err
+	}
+
+	if err := fn(); err != nil {
+		m.recordLocked(source, kind, false, err)
+		return err
+	}
+	if m.policy.LockoutWindow > 0 {
+		m.lockoutUntil = time.Now().UTC().Add(m.policy.LockoutWindow)
+	}
+	m.recordLocked(source, kind, true, nil)
+	return nil
+}
+
+func (m *ManagedWriter) ensureProfileAllows(kind string) error {
+	switch m.policy.Profile {
+	case WriterProfileReadOnly:
+		return errors.New("write denied by read-only profile")
+	case WriterProfileMaintenance:
+		if kind == "set_standby" || kind == "set_panel_state" {
+			return nil
+		}
+		return fmt.Errorf("maintenance profile blocks %s", kind)
+	default:
+		return nil
+	}
+}
+
+func (m *ManagedWriter) recordLocked(source CommandSource, kind string, allowed bool, err error) {
+	event := CommandEvent{
+		Timestamp: time.Now().UTC(),
+		Source:    source,
+		Kind:      kind,
+		Allowed:   allowed,
+	}
+	if err != nil {
+		event.Error = err.Error()
+	}
+	m.events = append(m.events, event)
+	if len(m.events) > 100 {
+		m.events = m.events[len(m.events)-100:]
+	}
+}
+
+func (m *ManagedWriter) baseWriter() SettingsWriter {
+	return m.writer
+}
+
+func panelStateLabel(state PanelSwitchState) string {
+	switch state {
+	case PanelSwitchOn:
+		return "on"
+	case PanelSwitchOff:
+		return "off"
+	case PanelSwitchChargerOnly:
+		return "charger_only"
+	case PanelSwitchInverterOnly:
+		return "inverter_only"
+	default:
+		return fmt.Sprintf("unknown(0x%02x)", byte(state))
+	}
+}
+
+func stringsForAllowedPanelStates(states map[PanelSwitchState]struct{}) string {
+	if len(states) == 0 {
+		return "<none>"
+	}
+	labels := make([]string, 0, len(states))
+	for state := range states {
+		labels = append(labels, panelStateLabel(state))
+	}
+	sort.Strings(labels)
+	return fmt.Sprintf("%v", labels)
+}

mk2driver/managed_writer_test.go

@@ -0,0 +1,97 @@
+package mk2driver
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+type writerStub struct {
+	settingWrites int
+	ramWrites     int
+	panelWrites   int
+	standbyWrites int
+}
+
+func (w *writerStub) WriteRAMVar(id uint16, value int16) error {
+	w.ramWrites++
+	return nil
+}
+
+func (w *writerStub) WriteSetting(id uint16, value int16) error {
+	w.settingWrites++
+	return nil
+}
+
+func (w *writerStub) SetPanelState(switchState PanelSwitchState, currentLimitA *float64) error {
+	w.panelWrites++
+	return nil
+}
+
+func (w *writerStub) SetStandby(enabled bool) error {
+	w.standbyWrites++
+	return nil
+}
+
+func TestManagedWriterReadOnlyProfile(t *testing.T) {
+	base := &writerStub{}
+	managed := NewManagedWriter(base, WriterPolicy{
+		Profile: WriterProfileReadOnly,
+	})
+
+	err := managed.WriteSettingWithSource(CommandSourceMQTT, 1, 1)
+	assert.Error(t, err)
+	assert.Equal(t, 0, base.settingWrites)
+	history := managed.History(10)
+	if assert.Len(t, history, 1) {
+		assert.False(t, history[0].Allowed)
+		assert.Equal(t, CommandSourceMQTT, history[0].Source)
+	}
+}
+
+func TestManagedWriterCurrentLimitGuard(t *testing.T) {
+	base := &writerStub{}
+	max := 16.0
+	managed := NewManagedWriter(base, WriterPolicy{
+		Profile:          WriterProfileNormal,
+		MaxCurrentLimitA: &max,
+	})
+
+	limit := 20.0
+	err := managed.SetPanelStateWithSource(CommandSourceUI, PanelSwitchOn, &limit)
+	assert.Error(t, err)
+	assert.Equal(t, 0, base.panelWrites)
+}
+
+func TestManagedWriterModeRateLimit(t *testing.T) {
+	base := &writerStub{}
+	managed := NewManagedWriter(base, WriterPolicy{
+		Profile:               WriterProfileNormal,
+		ModeChangeMinInterval: 10 * time.Second,
+	})
+
+	err := managed.SetPanelStateWithSource(CommandSourceAutomation, PanelSwitchOn, nil)
+	assert.NoError(t, err)
+	err = managed.SetPanelStateWithSource(CommandSourceAutomation, PanelSwitchOff, nil)
+	assert.Error(t, err)
+	assert.Equal(t, 1, base.panelWrites)
+}
+
+func TestManagedWriterPanelModeAllowlist(t *testing.T) {
+	base := &writerStub{}
+	managed := NewManagedWriter(base, WriterPolicy{
+		Profile: WriterProfileNormal,
+		AllowedPanelStates: map[PanelSwitchState]struct{}{
+			PanelSwitchOff: {},
+		},
+	})
+
+	err := managed.SetPanelStateWithSource(CommandSourceMQTT, PanelSwitchOn, nil)
+	assert.Error(t, err)
+	assert.Equal(t, 0, base.panelWrites)
+
+	err = managed.SetPanelStateWithSource(CommandSourceMQTT, PanelSwitchOff, nil)
+	assert.NoError(t, err)
+	assert.Equal(t, 1, base.panelWrites)
+}

mk2driver/metadata.go

@@ -0,0 +1,332 @@
+package mk2driver
+
+import (
+	"fmt"
+	"math"
+	"sort"
+	"time"
+)
+
+const (
+	defaultTransactionRetries    = 2
+	defaultTransactionRetryDelay = 200 * time.Millisecond
+	defaultTransactionBackoff    = 1.5
+	fastCommandTimeout           = 1500 * time.Millisecond
+	standardCommandTimeout       = 3 * time.Second
+	slowCommandTimeout           = 6 * time.Second
+)
+
+type registerKey struct {
+	kind RegisterKind
+	id   uint16
+}
+
+func int16Ptr(v int16) *int16 {
+	return &v
+}
+
+var knownRegisterMetadata = map[registerKey]RegisterMetadata{
+	{kind: RegisterKindRAMVar, id: ramVarVMains}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarVMains,
+		Name:        "mains_voltage",
+		Description: "AC input mains voltage (scaled)",
+		Unit:        "V",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarIMains}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarIMains,
+		Name:        "mains_current",
+		Description: "AC input mains current (scaled)",
+		Unit:        "A",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarVInverter}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarVInverter,
+		Name:        "inverter_voltage",
+		Description: "AC output inverter voltage (scaled)",
+		Unit:        "V",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarIInverter}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarIInverter,
+		Name:        "inverter_current",
+		Description: "AC output inverter current (scaled)",
+		Unit:        "A",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarVBat}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarVBat,
+		Name:        "battery_voltage",
+		Description: "Battery voltage (scaled)",
+		Unit:        "V",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarIBat}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarIBat,
+		Name:        "battery_current",
+		Description: "Battery current (scaled)",
+		Unit:        "A",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarVBatRipple}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarVBatRipple,
+		Name:        "battery_voltage_ripple",
+		Description: "Battery ripple voltage (scaled)",
+		Unit:        "V",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarInverterPeriod}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarInverterPeriod,
+		Name:        "inverter_period",
+		Description: "Inverter period source value",
+		Unit:        "ticks",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarMainPeriod}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarMainPeriod,
+		Name:        "mains_period",
+		Description: "Mains period source value",
+		Unit:        "ticks",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarIACLoad}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarIACLoad,
+		Name:        "ac_load_current",
+		Description: "AC load current (scaled)",
+		Unit:        "A",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarVirSwitchPos}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarVirSwitchPos,
+		Name:        "virtual_switch_position",
+		Description: "Virtual switch position",
+		Unit:        "state",
+		Scale:       1,
+		Writable:    true,
+		Signed:      false,
+		MinValue:    int16Ptr(0),
+		MaxValue:    int16Ptr(255),
+		SafetyClass: RegisterSafetyGuarded,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarIgnACInState}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarIgnACInState,
+		Name:        "ignored_ac_input_state",
+		Description: "AC input state as seen by firmware",
+		Unit:        "state",
+		Scale:       1,
+		Writable:    false,
+		Signed:      false,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarMultiFuncRelay}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarMultiFuncRelay,
+		Name:        "multifunction_relay",
+		Description: "Multifunction relay state",
+		Unit:        "state",
+		Scale:       1,
+		Writable:    true,
+		Signed:      false,
+		MinValue:    int16Ptr(0),
+		MaxValue:    int16Ptr(1),
+		SafetyClass: RegisterSafetyOperational,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarChargeState}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarChargeState,
+		Name:        "battery_charge_state",
+		Description: "Battery charge state fraction",
+		Unit:        "fraction",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarInverterPower1}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarInverterPower1,
+		Name:        "inverter_power_1",
+		Description: "Inverter power source register 1",
+		Unit:        "W",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarInverterPower2}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarInverterPower2,
+		Name:        "inverter_power_2",
+		Description: "Inverter power source register 2",
+		Unit:        "W",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+	{kind: RegisterKindRAMVar, id: ramVarOutPower}: {
+		Kind:        RegisterKindRAMVar,
+		ID:          ramVarOutPower,
+		Name:        "output_power",
+		Description: "Output power source register",
+		Unit:        "W",
+		Scale:       1,
+		Writable:    false,
+		Signed:      true,
+		SafetyClass: RegisterSafetyReadOnly,
+	},
+}
+
+func normalizeTransactionOptions(opts TransactionOptions) TransactionOptions {
+	if opts.Retries < 0 {
+		opts.Retries = 0
+	}
+	if opts.RetryDelay < 0 {
+		opts.RetryDelay = 0
+	}
+	if opts.BackoffFactor <= 0 {
+		opts.BackoffFactor = defaultTransactionBackoff
+	}
+	if opts.Retries == 0 && opts.RetryDelay == 0 && !opts.ReadBeforeWrite && !opts.VerifyAfterWrite {
+		opts.Retries = defaultTransactionRetries
+		opts.RetryDelay = defaultTransactionRetryDelay
+		opts.BackoffFactor = defaultTransactionBackoff
+		opts.ReadBeforeWrite = true
+		opts.VerifyAfterWrite = true
+		opts.TimeoutClass = TimeoutClassStandard
+		return opts
+	}
+	if opts.RetryDelay == 0 {
+		opts.RetryDelay = defaultTransactionRetryDelay
+	}
+	if opts.TimeoutClass == "" {
+		opts.TimeoutClass = TimeoutClassStandard
+	}
+	return opts
+}
+
+func lookupRegisterMetadata(kind RegisterKind, id uint16) (RegisterMetadata, bool) {
+	meta, ok := knownRegisterMetadata[registerKey{kind: kind, id: id}]
+	if ok {
+		meta = withMetadataDefaults(meta)
+	}
+	return meta, ok
+}
+
+func listRegisterMetadata() []RegisterMetadata {
+	out := make([]RegisterMetadata, 0, len(knownRegisterMetadata))
+	for _, meta := range knownRegisterMetadata {
+		out = append(out, withMetadataDefaults(meta))
+	}
+	sort.Slice(out, func(i, j int) bool {
+		if out[i].Kind != out[j].Kind {
+			return out[i].Kind < out[j].Kind
+		}
+		return out[i].ID < out[j].ID
+	})
+	return out
+}
+
+func validateValueAgainstMetadata(meta RegisterMetadata, value int16) error {
+	if meta.MinValue != nil && value < *meta.MinValue {
+		return fmt.Errorf("value %d is below minimum %d for %s:%d", value, *meta.MinValue, meta.Kind, meta.ID)
+	}
+	if meta.MaxValue != nil && value > *meta.MaxValue {
+		return fmt.Errorf("value %d is above maximum %d for %s:%d", value, *meta.MaxValue, meta.Kind, meta.ID)
+	}
+	return nil
+}
+
+func withMetadataDefaults(meta RegisterMetadata) RegisterMetadata {
+	if meta.Scale == 0 {
+		meta.Scale = 1
+	}
+	if meta.SafetyClass == "" {
+		if meta.Writable {
+			meta.SafetyClass = RegisterSafetyGuarded
+		} else {
+			meta.SafetyClass = RegisterSafetyReadOnly
+		}
+	}
+	return meta
+}
+
+func resolveCommandTimeout(opts TransactionOptions) time.Duration {
+	if opts.CommandTimeout > 0 {
+		return opts.CommandTimeout
+	}
+	switch opts.TimeoutClass {
+	case TimeoutClassFast:
+		return fastCommandTimeout
+	case TimeoutClassSlow:
+		return slowCommandTimeout
+	default:
+		return standardCommandTimeout
+	}
+}
+
+func retryDelayForAttempt(opts TransactionOptions, attempt int) time.Duration {
+	if opts.RetryDelay <= 0 || attempt <= 1 {
+		return opts.RetryDelay
+	}
+	factor := math.Pow(opts.BackoffFactor, float64(attempt-1))
+	delay := float64(opts.RetryDelay) * factor
+	return time.Duration(delay)
+}
+
+func defaultWritableRegisterAddresses() []RegisterAddress {
+	metas := listRegisterMetadata()
+	out := make([]RegisterAddress, 0, len(metas))
+	for _, meta := range metas {
+		if !meta.Writable {
+			continue
+		}
+		out = append(out, RegisterAddress{
+			Kind: meta.Kind,
+			ID:   meta.ID,
+		})
+	}
+	return out
+}

mk2driver/mk2_test.go

@@ -50,6 +50,31 @@ func NewIOStub(readBuffer []byte) io.ReadWriter {
 	}
 }
 
+func buildTestFrame(frameType byte, payload ...byte) (byte, []byte) {
+	length := byte(len(payload) + 1)
+	sum := int(length) + int(frameType)
+	for _, b := range payload {
+		sum += int(b)
+	}
+	checksum := byte((-sum) & 0xff)
+	frame := append([]byte{frameType}, payload...)
+	frame = append(frame, checksum)
+	return length, frame
+}
+
+func buildSentCommand(payload ...byte) []byte {
+	length := byte(len(payload) + 1)
+	sum := int(length) + int(frameHeader)
+	out := make([]byte, 0, len(payload)+3)
+	out = append(out, length, frameHeader)
+	for _, b := range payload {
+		sum += int(b)
+		out = append(out, b)
+	}
+	out = append(out, byte((-sum)&0xff))
+	return out
+}
+
 // Test a know sequence as reference as extracted from Mk2
 func TestSync(t *testing.T) {
 	tests := []struct {
@@ -320,6 +345,29 @@ func Test_mk2Ser_WriteSetting(t *testing.T) {
 	}
 
 	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteViaIDResponse)
+	}()
+
+	err := m.WriteSetting(0x1234, 1234)
+	assert.NoError(t, err)
+
+	expected := []byte{
+		0x07, 0xff, 0x57, 0x37, 0x34, 0x12, 0xd2, 0x04, 0x50,
+	}
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_WriteSetting_FallbackLegacy(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:        testIO,
+		writeAck: make(chan byte, 2),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandUnsupportedResponse)
 		time.Sleep(10 * time.Millisecond)
 		m.pushWriteResponse(commandWriteSettingResponse)
 	}()
@@ -328,12 +376,358 @@ func Test_mk2Ser_WriteSetting(t *testing.T) {
 	assert.NoError(t, err)
 
 	expected := []byte{
+		0x07, 0xff, 0x57, 0x37, 0x34, 0x12, 0xd2, 0x04, 0x50,
 		0x05, 0xff, 0x57, 0x33, 0x34, 0x12, 0x2c,
 		0x05, 0xff, 0x57, 0x34, 0xd2, 0x04, 0x9b,
 	}
 	assert.Equal(t, expected, writeBuffer.Bytes())
 }
 
+func Test_mk2Ser_WriteRAMVar(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:        testIO,
+		writeAck: make(chan byte, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteRAMViaIDResponse)
+	}()
+
+	err := m.WriteRAMVar(0x000d, 1)
+	assert.NoError(t, err)
+
+	expected := buildSentCommand(winmonFrame, commandWriteRAMViaID, 0x0d, 0x00, 0x01, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_WriteRAMVar_FallbackLegacy(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:        testIO,
+		writeAck: make(chan byte, 2),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandUnsupportedResponse)
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteRAMResponse)
+	}()
+
+	err := m.WriteRAMVar(0x000d, 1)
+	assert.NoError(t, err)
+
+	expected := append([]byte{}, buildSentCommand(winmonFrame, commandWriteRAMViaID, 0x0d, 0x00, 0x01, 0x00)...)
+	expected = append(expected, buildSentCommand(winmonFrame, commandWriteRAMVar, 0x0d, 0x00)...)
+	expected = append(expected, buildSentCommand(winmonFrame, commandWriteData, 0x01, 0x00)...)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_WriteSettingByID(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:        testIO,
+		writeAck: make(chan byte, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteViaIDResponse)
+	}()
+
+	err := m.WriteSettingByID(0x1234, 1234)
+	assert.NoError(t, err)
+
+	expected := buildSentCommand(winmonFrame, commandWriteViaID, 0x34, 0x12, 0xd2, 0x04)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_WriteRAMVarByID(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:        testIO,
+		writeAck: make(chan byte, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteRAMViaIDResponse)
+	}()
+
+	err := m.WriteRAMVarByID(0x000d, 1)
+	assert.NoError(t, err)
+
+	expected := buildSentCommand(winmonFrame, commandWriteRAMViaID, 0x0d, 0x00, 0x01, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_RegisterMetadata(t *testing.T) {
+	m := &mk2Ser{}
+
+	meta, ok := m.RegisterMetadata(RegisterKindRAMVar, ramVarVBat)
+	assert.True(t, ok)
+	assert.Equal(t, RegisterKindRAMVar, meta.Kind)
+	assert.Equal(t, uint16(ramVarVBat), meta.ID)
+	assert.Equal(t, "battery_voltage", meta.Name)
+	assert.False(t, meta.Writable)
+
+	_, ok = m.RegisterMetadata(RegisterKindSetting, 9999)
+	assert.False(t, ok)
+
+	all := m.ListRegisterMetadata()
+	assert.NotEmpty(t, all)
+}
+
+func Test_mk2Ser_WriteRegister_Verified(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		writeAck:  make(chan byte, 2),
+		winmonAck: make(chan winmonResponse, 4),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		// Read-before-write response.
+		m.pushWinmonResponse(commandReadSettingResponse, []byte{0x01, 0x00})
+		time.Sleep(10 * time.Millisecond)
+		// Write acknowledgement.
+		m.pushWriteResponse(commandWriteViaIDResponse)
+		time.Sleep(10 * time.Millisecond)
+		// Verify-after-write response.
+		m.pushWinmonResponse(commandReadSettingResponse, []byte{0x34, 0x12})
+	}()
+
+	result, err := m.WriteRegister(RegisterKindSetting, 0x0042, 0x1234, TransactionOptions{
+		ReadBeforeWrite:  true,
+		VerifyAfterWrite: true,
+	})
+	assert.NoError(t, err)
+	assert.Equal(t, 1, result.Attempts)
+	if assert.NotNil(t, result.PreviousValue) {
+		assert.Equal(t, int16(1), *result.PreviousValue)
+	}
+	if assert.NotNil(t, result.VerifiedValue) {
+		assert.Equal(t, int16(0x1234), *result.VerifiedValue)
+	}
+
+	expected := append([]byte{}, buildSentCommand(winmonFrame, commandReadSetting, 0x42, 0x00)...)
+	expected = append(expected, buildSentCommand(winmonFrame, commandWriteViaID, 0x42, 0x00, 0x34, 0x12)...)
+	expected = append(expected, buildSentCommand(winmonFrame, commandReadSetting, 0x42, 0x00)...)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_WriteRegister_VerifyRetry(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		writeAck:  make(chan byte, 4),
+		winmonAck: make(chan winmonResponse, 8),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteViaIDResponse)
+		time.Sleep(10 * time.Millisecond)
+		// First verify mismatch.
+		m.pushWinmonResponse(commandReadSettingResponse, []byte{0x00, 0x00})
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteViaIDResponse)
+		time.Sleep(10 * time.Millisecond)
+		// Second verify matches expected value.
+		m.pushWinmonResponse(commandReadSettingResponse, []byte{0x78, 0x56})
+	}()
+
+	result, err := m.WriteRegister(RegisterKindSetting, 0x0042, 0x5678, TransactionOptions{
+		Retries:          1,
+		RetryDelay:       1 * time.Millisecond,
+		VerifyAfterWrite: true,
+	})
+	assert.NoError(t, err)
+	assert.Equal(t, 2, result.Attempts)
+	if assert.NotNil(t, result.VerifiedValue) {
+		assert.Equal(t, int16(0x5678), *result.VerifiedValue)
+	}
+}
+
+func Test_mk2Ser_WriteRegister_ReadOnlyMetadata(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:        testIO,
+		writeAck: make(chan byte, 1),
+	}
+
+	_, err := m.WriteRegister(RegisterKindRAMVar, ramVarVBat, 1, TransactionOptions{
+		VerifyAfterWrite: true,
+	})
+	assert.Error(t, err)
+	assert.ErrorContains(t, err, "read-only")
+	assert.Empty(t, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_GetDeviceState(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandSetStateResponse, []byte{0x00, byte(DeviceStateOn)})
+	}()
+
+	state, err := m.GetDeviceState()
+	assert.NoError(t, err)
+	assert.Equal(t, DeviceStateOn, state)
+
+	expected := buildSentCommand(winmonFrame, commandSetState, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_SetDeviceState(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandSetStateResponse, []byte{0x00, byte(DeviceStateOff)})
+	}()
+
+	err := m.SetDeviceState(DeviceStateOff)
+	assert.NoError(t, err)
+
+	expected := buildSentCommand(winmonFrame, commandSetState, 0x00, byte(DeviceStateOff))
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_ReadRAMVarByID(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandReadRAMResponse, []byte{0x34, 0x12})
+	}()
+
+	value, err := m.ReadRAMVarByID(0x0021)
+	assert.NoError(t, err)
+	assert.Equal(t, int16(0x1234), value)
+
+	expected := buildSentCommand(winmonFrame, commandReadRAMVar, 0x21, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_ReadSettingByID(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandReadSettingResponse, []byte{0xcd, 0xab})
+	}()
+
+	value, err := m.ReadSettingByID(0x0042)
+	assert.NoError(t, err)
+	assert.Equal(t, int16(-21555), value)
+
+	expected := buildSentCommand(winmonFrame, commandReadSetting, 0x42, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_ReadSelected(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandReadSelectedResponse, []byte{0x78, 0x56})
+	}()
+
+	value, err := m.ReadSelected()
+	assert.NoError(t, err)
+	assert.Equal(t, int16(0x5678), value)
+
+	expected := buildSentCommand(winmonFrame, commandReadSelected)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_SelectRAMVar(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandReadRAMResponse, []byte{0x11, 0x22})
+	}()
+
+	err := m.SelectRAMVar(0x0022)
+	assert.NoError(t, err)
+
+	expected := buildSentCommand(winmonFrame, commandReadRAMVar, 0x22, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_SelectSetting(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandReadSettingResponse, []byte{0x11, 0x22})
+	}()
+
+	err := m.SelectSetting(0x0023)
+	assert.NoError(t, err)
+
+	expected := buildSentCommand(winmonFrame, commandReadSetting, 0x23, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_ReadRAMVarInfo(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandGetRAMVarInfoResponse, []byte{0x9c, 0x7f, 0x00, 0x8f, 0x00})
+	}()
+
+	info, err := m.ReadRAMVarInfo(0x0001)
+	assert.NoError(t, err)
+	assert.True(t, info.Supported)
+	assert.Equal(t, uint16(0x0001), info.ID)
+	assert.Equal(t, int16(0x7f9c), info.Scale)
+	assert.Equal(t, int16(0x008f), info.Offset)
+	assert.InDelta(t, 0.01, info.Factor, testDelta)
+
+	expected := buildSentCommand(winmonFrame, commandGetRAMVarInfo, 0x01, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
 func Test_mk2Ser_WriteRAMVarRejected(t *testing.T) {
 	testIO := NewIOStub(nil)
 	m := &mk2Ser{
@@ -435,3 +829,197 @@ func Test_mk2Ser_SetStandby_Disabled(t *testing.T) {
 	}
 	assert.Equal(t, expected, writeBuffer.Bytes())
 }
+
+func Test_mk2Ser_WriteSettingBySelection(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:        testIO,
+		writeAck: make(chan byte, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteSettingResponse)
+	}()
+
+	err := m.WriteSettingBySelection(0x0020, 0x0011)
+	assert.NoError(t, err)
+
+	expected := append([]byte{}, buildSentCommand(winmonFrame, commandWriteSetting, 0x20, 0x00)...)
+	expected = append(expected, buildSentCommand(winmonFrame, commandWriteData, 0x11, 0x00)...)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_WriteSelectedData(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:        testIO,
+		writeAck: make(chan byte, 1),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWriteResponse(commandWriteRAMResponse)
+	}()
+
+	err := m.WriteSelectedData(0x0022)
+	assert.NoError(t, err)
+
+	expected := buildSentCommand(winmonFrame, commandWriteData, 0x22, 0x00)
+	assert.Equal(t, expected, writeBuffer.Bytes())
+}
+
+func Test_mk2Ser_CaptureAndDiffSnapshot(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 2),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandReadRAMResponse, []byte{0x03, 0x00})
+		time.Sleep(10 * time.Millisecond)
+		m.pushWinmonResponse(commandReadRAMResponse, []byte{0x04, 0x00})
+	}()
+
+	addresses := []RegisterAddress{
+		{Kind: RegisterKindRAMVar, ID: ramVarVirSwitchPos},
+	}
+	snapshot, err := m.CaptureSnapshot(addresses)
+	assert.NoError(t, err)
+	if assert.Len(t, snapshot.Entries, 1) {
+		assert.Equal(t, RegisterSafetyGuarded, snapshot.Entries[0].Safety)
+		assert.Equal(t, int16(3), snapshot.Entries[0].Value)
+	}
+
+	diffs, err := m.DiffSnapshot(snapshot)
+	assert.NoError(t, err)
+	if assert.Len(t, diffs, 1) {
+		assert.True(t, diffs[0].Changed)
+		assert.Equal(t, int16(4), diffs[0].Current)
+		assert.Equal(t, int16(3), diffs[0].Target)
+	}
+}
+
+func Test_mk2Ser_RestoreSnapshot(t *testing.T) {
+	testIO := NewIOStub(nil)
+	m := &mk2Ser{
+		p:         testIO,
+		winmonAck: make(chan winmonResponse, 4),
+		writeAck:  make(chan byte, 2),
+	}
+
+	go func() {
+		time.Sleep(10 * time.Millisecond)
+		// DiffSnapshot current value.
+		m.pushWinmonResponse(commandReadRAMResponse, []byte{0x04, 0x00})
+		time.Sleep(10 * time.Millisecond)
+		// WriteRegister read-before-write.
+		m.pushWinmonResponse(commandReadRAMResponse, []byte{0x04, 0x00})
+		time.Sleep(10 * time.Millisecond)
+		// Write ack.
+		m.pushWriteResponse(commandWriteRAMViaIDResponse)
+		time.Sleep(10 * time.Millisecond)
+		// Verify-after-write.
+		m.pushWinmonResponse(commandReadRAMResponse, []byte{0x03, 0x00})
+	}()
+
+	result, err := m.RestoreSnapshot(RegisterSnapshot{
+		Entries: []RegisterSnapshotEntry{
+			{
+				Kind:     RegisterKindRAMVar,
+				ID:       ramVarVirSwitchPos,
+				Value:    3,
+				Writable: true,
+			},
+		},
+	}, TransactionOptions{
+		ReadBeforeWrite:  true,
+		VerifyAfterWrite: true,
+		RetryDelay:       1 * time.Millisecond,
+	})
+	assert.NoError(t, err)
+	assert.False(t, result.RolledBack)
+	if assert.Len(t, result.Applied, 1) {
+		if assert.NotNil(t, result.Applied[0].PreviousValue) {
+			assert.Equal(t, int16(4), *result.Applied[0].PreviousValue)
+		}
+	}
+}
+
+func Test_mk2Ser_DriverDiagnostics(t *testing.T) {
+	m := &mk2Ser{
+		traceLimit: 10,
+		traces:     make([]ProtocolTrace, 0, 10),
+	}
+	m.appendTrace(ProtocolTrace{
+		Timestamp: time.Now().UTC(),
+		Direction: TraceDirectionTX,
+		Frame:     "0x57",
+		Command:   "winmon:0x30",
+		BytesHex:  "AA",
+	})
+	m.noteCommandFailure(assert.AnError)
+	m.noteCommandTimeout(assert.AnError)
+	m.checksumErrors.Add(1)
+	m.markFrameSeen()
+
+	diag := m.DriverDiagnostics(10)
+	assert.NotEmpty(t, diag.Traces)
+	assert.Greater(t, diag.CommandFailures, uint64(0))
+	assert.Greater(t, diag.CommandTimeouts, uint64(0))
+	assert.Greater(t, diag.ChecksumFailures, uint64(0))
+	assert.GreaterOrEqual(t, diag.HealthScore, 0)
+}
+
+func Test_parseFrameLength(t *testing.T) {
+	tests := []struct {
+		name         string
+		raw          byte
+		expectedLen  byte
+		expectedFlag bool
+	}{
+		{
+			name:         "normal length",
+			raw:          0x07,
+			expectedLen:  0x07,
+			expectedFlag: false,
+		},
+		{
+			name:         "length with LED flag",
+			raw:          0x86,
+			expectedLen:  0x06,
+			expectedFlag: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			length, hasLEDStatus := parseFrameLength(tt.raw)
+			assert.Equal(t, tt.expectedLen, length)
+			assert.Equal(t, tt.expectedFlag, hasLEDStatus)
+		})
+	}
+}
+
+func Test_mk2Ser_handleFrame_StateFrameWithAppendedLED(t *testing.T) {
+	m := &mk2Ser{
+		info:     &Mk2Info{},
+		stateAck: make(chan struct{}, 1),
+	}
+
+	length, frame := buildTestFrame(frameHeader, stateFrame)
+	m.handleFrame(length, frame, []byte{0x03, 0x00})
+
+	select {
+	case <-m.stateAck:
+	default:
+		t.Fatal("expected state acknowledgement")
+	}
+
+	assert.NotNil(t, m.info.LEDs)
+	assert.Equal(t, LedOn, m.info.LEDs[LedMain])
+	assert.Equal(t, LedOn, m.info.LEDs[LedAbsorption])
+	assert.Equal(t, LedOff, m.info.LEDs[LedBulk])
+}

mk2driver/mk2interface.go

@@ -102,3 +102,251 @@ type SettingsWriter interface {
 	// When enabled, the inverter is prevented from sleeping while switched off.
 	SetStandby(enabled bool) error
 }
+
+type DeviceState byte
+
+const (
+	// DeviceStateChargerOnly enables charging only.
+	DeviceStateChargerOnly DeviceState = 0x02
+	// DeviceStateInverterOnly enables inverter output and disables charging.
+	DeviceStateInverterOnly DeviceState = 0x03
+	// DeviceStateOn enables both inverter and charger.
+	DeviceStateOn DeviceState = 0x04
+	// DeviceStateOff disables inverter and charger.
+	DeviceStateOff DeviceState = 0x05
+)
+
+var DeviceStateNames = map[DeviceState]string{
+	DeviceStateChargerOnly:  "charger_only",
+	DeviceStateInverterOnly: "inverter_only",
+	DeviceStateOn:           "on",
+	DeviceStateOff:          "off",
+}
+
+type RAMVarInfo struct {
+	ID        uint16
+	Scale     int16
+	Offset    int16
+	Factor    float64
+	Signed    bool
+	Supported bool
+}
+
+// ProtocolControl exposes protocol 3.14 command paths for direct MK2 control.
+type ProtocolControl interface {
+	SettingsWriter
+	// GetDeviceState returns the current VE.Bus state using command 0x0E.
+	GetDeviceState() (DeviceState, error)
+	// SetDeviceState sets the VE.Bus state using command 0x0E.
+	SetDeviceState(state DeviceState) error
+	// ReadRAMVarByID reads a RAM variable via command 0x30.
+	ReadRAMVarByID(id uint16) (int16, error)
+	// ReadSettingByID reads a setting via command 0x31.
+	ReadSettingByID(id uint16) (int16, error)
+	// SelectRAMVar selects a RAM variable for follow-up read-selected/write-selected paths.
+	SelectRAMVar(id uint16) error
+	// SelectSetting selects a setting for follow-up read-selected/write-selected paths.
+	SelectSetting(id uint16) error
+	// ReadSelected reads the currently selected value via command 0x35.
+	ReadSelected() (int16, error)
+	// ReadRAMVarInfo reads RAM variable metadata via command 0x36.
+	ReadRAMVarInfo(id uint16) (RAMVarInfo, error)
+	// WriteSelectedData writes to the currently selected register via command 0x34.
+	WriteSelectedData(value int16) error
+	// WriteSettingBySelection performs 0x33 (select setting) followed by 0x34 (write data).
+	WriteSettingBySelection(id uint16, value int16) error
+	// WriteRAMVarBySelection performs 0x32 (select RAM var) followed by 0x34 (write data).
+	WriteRAMVarBySelection(id uint16, value int16) error
+	// WriteSettingByID writes a setting via command 0x37.
+	WriteSettingByID(id uint16, value int16) error
+	// WriteRAMVarByID writes a RAM variable via command 0x38.
+	WriteRAMVarByID(id uint16, value int16) error
+}
+
+type RegisterKind string
+
+const (
+	RegisterKindSetting RegisterKind = "setting"
+	RegisterKindRAMVar  RegisterKind = "ram_var"
+)
+
+type RegisterSafetyClass string
+
+const (
+	// RegisterSafetyReadOnly indicates no write path should be exposed.
+	RegisterSafetyReadOnly RegisterSafetyClass = "read_only"
+	// RegisterSafetyOperational indicates normal runtime write usage is expected.
+	RegisterSafetyOperational RegisterSafetyClass = "operational"
+	// RegisterSafetyGuarded indicates writes should be policy-guarded.
+	RegisterSafetyGuarded RegisterSafetyClass = "guarded"
+	// RegisterSafetyCritical indicates high-impact settings that need stricter controls.
+	RegisterSafetyCritical RegisterSafetyClass = "critical"
+)
+
+type TimeoutClass string
+
+const (
+	TimeoutClassFast     TimeoutClass = "fast"
+	TimeoutClassStandard TimeoutClass = "standard"
+	TimeoutClassSlow     TimeoutClass = "slow"
+)
+
+// RegisterMetadata documents known MK2 register IDs and expected value behavior.
+type RegisterMetadata struct {
+	Kind        RegisterKind
+	ID          uint16
+	Name        string
+	Description string
+	Unit        string
+	Scale       float64
+	Writable    bool
+	Signed      bool
+	MinValue    *int16
+	MaxValue    *int16
+	SafetyClass RegisterSafetyClass
+}
+
+// TransactionOptions controls retry and verification semantics for safe writes.
+type TransactionOptions struct {
+	// Retries is the number of additional write attempts after the first try.
+	Retries int
+	// RetryDelay is slept between retries. Zero uses a sensible default.
+	RetryDelay time.Duration
+	// BackoffFactor multiplies retry delay for each additional attempt (1 disables backoff).
+	BackoffFactor float64
+	// ReadBeforeWrite captures previous value before writing when possible.
+	ReadBeforeWrite bool
+	// VerifyAfterWrite reads the register back and compares with written value.
+	VerifyAfterWrite bool
+	// TimeoutClass applies standard timeout buckets when CommandTimeout is not set.
+	TimeoutClass TimeoutClass
+	// CommandTimeout overrides timeout class for each protocol command inside the transaction.
+	CommandTimeout time.Duration
+}
+
+// RegisterTransactionResult reports details about a transactional register write.
+type RegisterTransactionResult struct {
+	Kind          RegisterKind
+	ID            uint16
+	TargetValue   int16
+	PreviousValue *int16
+	VerifiedValue *int16
+	Attempts      int
+	Timeout       time.Duration
+	Duration      time.Duration
+}
+
+// MetadataControl adds register metadata and transactional safety helpers.
+type MetadataControl interface {
+	ProtocolControl
+	// RegisterMetadata returns metadata for a known register.
+	RegisterMetadata(kind RegisterKind, id uint16) (RegisterMetadata, bool)
+	// ListRegisterMetadata returns all known register metadata.
+	ListRegisterMetadata() []RegisterMetadata
+	// ReadRegister reads a setting or RAM var by kind and id.
+	ReadRegister(kind RegisterKind, id uint16) (int16, error)
+	// WriteRegister performs a safe transactional write with optional retry/verify.
+	WriteRegister(kind RegisterKind, id uint16, value int16, opts TransactionOptions) (RegisterTransactionResult, error)
+}
+
+type RegisterAddress struct {
+	Kind RegisterKind `json:"kind"`
+	ID   uint16       `json:"id"`
+}
+
+type RegisterSnapshotEntry struct {
+	Kind       RegisterKind        `json:"kind"`
+	ID         uint16              `json:"id"`
+	Name       string              `json:"name,omitempty"`
+	Value      int16               `json:"value"`
+	Writable   bool                `json:"writable"`
+	Safety     RegisterSafetyClass `json:"safety_class,omitempty"`
+	CapturedAt time.Time           `json:"captured_at"`
+}
+
+type RegisterSnapshot struct {
+	CapturedAt time.Time               `json:"captured_at"`
+	Entries    []RegisterSnapshotEntry `json:"entries"`
+}
+
+type SnapshotDiff struct {
+	Kind      RegisterKind        `json:"kind"`
+	ID        uint16              `json:"id"`
+	Name      string              `json:"name,omitempty"`
+	Current   int16               `json:"current"`
+	Target    int16               `json:"target"`
+	Changed   bool                `json:"changed"`
+	Writable  bool                `json:"writable"`
+	Safety    RegisterSafetyClass `json:"safety_class,omitempty"`
+	DiffValue int32               `json:"diff_value"`
+}
+
+type SnapshotRestoreResult struct {
+	Applied        []RegisterTransactionResult `json:"applied"`
+	RolledBack     bool                        `json:"rolled_back"`
+	RollbackErrors []string                    `json:"rollback_errors,omitempty"`
+}
+
+// SnapshotControl provides register snapshot, diff preview, and rollback-aware restore.
+type SnapshotControl interface {
+	MetadataControl
+	// CaptureSnapshot reads the provided register list. Empty addresses captures known writable registers.
+	CaptureSnapshot(addresses []RegisterAddress) (RegisterSnapshot, error)
+	// DiffSnapshot compares current values against a snapshot.
+	DiffSnapshot(snapshot RegisterSnapshot) ([]SnapshotDiff, error)
+	// RestoreSnapshot applies snapshot target values; if restore fails mid-way it attempts rollback.
+	RestoreSnapshot(snapshot RegisterSnapshot, opts TransactionOptions) (SnapshotRestoreResult, error)
+}
+
+type TraceDirection string
+
+const (
+	TraceDirectionTX TraceDirection = "tx"
+	TraceDirectionRX TraceDirection = "rx"
+)
+
+type ProtocolTrace struct {
+	Timestamp time.Time      `json:"timestamp"`
+	Direction TraceDirection `json:"direction"`
+	Frame     string         `json:"frame"`
+	Command   string         `json:"command,omitempty"`
+	BytesHex  string         `json:"bytes_hex"`
+}
+
+type DriverDiagnostics struct {
+	GeneratedAt      time.Time       `json:"generated_at"`
+	HealthScore      int             `json:"health_score"`
+	LastFrameAt      *time.Time      `json:"last_frame_at,omitempty"`
+	CommandTimeouts  uint64          `json:"command_timeouts"`
+	CommandFailures  uint64          `json:"command_failures"`
+	ChecksumFailures uint64          `json:"checksum_failures"`
+	RecentErrors     []string        `json:"recent_errors,omitempty"`
+	Traces           []ProtocolTrace `json:"traces"`
+}
+
+// DiagnosticsControl exposes recent protocol traces and health information for troubleshooting bundles.
+type DiagnosticsControl interface {
+	DriverDiagnostics(limit int) DriverDiagnostics
+}
+
+type CommandSource string
+
+const (
+	CommandSourceUnknown    CommandSource = "unknown"
+	CommandSourceUI         CommandSource = "ui"
+	CommandSourceMQTT       CommandSource = "mqtt"
+	CommandSourceAutomation CommandSource = "automation"
+)
+
+// SourceAwareSettingsWriter accepts source tags for arbitration and diagnostics.
+type SourceAwareSettingsWriter interface {
+	SettingsWriter
+	WriteRAMVarWithSource(source CommandSource, id uint16, value int16) error
+	WriteSettingWithSource(source CommandSource, id uint16, value int16) error
+	SetPanelStateWithSource(source CommandSource, switchState PanelSwitchState, currentLimitA *float64) error
+	SetStandbyWithSource(source CommandSource, enabled bool) error
+}
+
+type CommandHistoryProvider interface {
+	History(limit int) []CommandEvent
+}

mk2driver/mockmk2.go

@@ -8,6 +8,8 @@ type mock struct {
 	c chan *Mk2Info
 }
 
+var _ ProtocolControl = (*mock)(nil)
+
 func NewMk2Mock() Mk2 {
 	tmp := &mock{
 		c: make(chan *Mk2Info, 1),
@@ -53,6 +55,61 @@ func (m *mock) SetStandby(_ bool) error {
 	return nil
 }
 
+func (m *mock) GetDeviceState() (DeviceState, error) {
+	return DeviceStateOn, nil
+}
+
+func (m *mock) SetDeviceState(_ DeviceState) error {
+	return nil
+}
+
+func (m *mock) ReadRAMVarByID(_ uint16) (int16, error) {
+	return 0, nil
+}
+
+func (m *mock) ReadSettingByID(_ uint16) (int16, error) {
+	return 0, nil
+}
+
+func (m *mock) SelectRAMVar(_ uint16) error {
+	return nil
+}
+
+func (m *mock) SelectSetting(_ uint16) error {
+	return nil
+}
+
+func (m *mock) ReadSelected() (int16, error) {
+	return 0, nil
+}
+
+func (m *mock) ReadRAMVarInfo(id uint16) (RAMVarInfo, error) {
+	return RAMVarInfo{
+		ID:        id,
+		Supported: false,
+	}, nil
+}
+
+func (m *mock) WriteSettingByID(_ uint16, _ int16) error {
+	return nil
+}
+
+func (m *mock) WriteRAMVarByID(_ uint16, _ int16) error {
+	return nil
+}
+
+func (m *mock) WriteSelectedData(_ int16) error {
+	return nil
+}
+
+func (m *mock) WriteSettingBySelection(_ uint16, _ int16) error {
+	return nil
+}
+
+func (m *mock) WriteRAMVarBySelection(_ uint16, _ int16) error {
+	return nil
+}
+
 func (m *mock) genMockValues() {
 	mult := 1.0
 	ledState := LedOff

plugins/cli/cli.go

@@ -1,7 +1,7 @@
 package cli
 
 import (
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
 	"github.com/sirupsen/logrus"
 )
 

plugins/mqttclient/mqtt_test.go

@@ -2,8 +2,9 @@ package mqttclient
 
 import (
 	"testing"
+	"time"
 
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -57,6 +58,7 @@ func Test_decodeWriteCommand(t *testing.T) {
 			payload: `{"request_id":"abc","kind":"setting","id":15,"value":-5}`,
 			check: func(t *testing.T, got writeCommand) {
 				assert.Equal(t, writeCommand{
+					Source:    mk2driver.CommandSourceMQTT,
 					RequestID: "abc",
 					Kind:      commandKindSetting,
 					ID:        15,
@@ -69,9 +71,10 @@ func Test_decodeWriteCommand(t *testing.T) {
 			payload: `{"type":"ramvar","id":2,"value":7}`,
 			check: func(t *testing.T, got writeCommand) {
 				assert.Equal(t, writeCommand{
-					Kind:  commandKindRAMVar,
+					Source: mk2driver.CommandSourceMQTT,
-					ID:    2,
+					Kind:   commandKindRAMVar,
-					Value: 7,
+					ID:     2,
+					Value:  7,
 				}, got)
 			},
 		},
@@ -305,12 +308,196 @@ func Test_panelStateCacheResolvePanelCommand(t *testing.T) {
 	assert.Equal(t, "on", resolved.SwitchName)
 }
 
-func float64Ptr(in float64) *float64 {
-	return &in
-}
-
 func Test_normalizeID(t *testing.T) {
 	assert.Equal(t, "victron_main_01", normalizeID("Victron Main #01"))
 	assert.Equal(t, "inverter-gui", normalizeID(" inverter-gui "))
 	assert.Equal(t, "", normalizeID("   "))
 }
+
+func Test_decodeVenusWriteCommand(t *testing.T) {
+	cfg := Config{
+		ClientID: "inverter-gui",
+		Venus: VenusConfig{
+			Enabled:     true,
+			PortalID:    "site01",
+			Service:     "vebus/257",
+			GuideCompat: true,
+		},
+	}
+
+	tests := []struct {
+		name      string
+		topic     string
+		payload   string
+		assertion func(*testing.T, writeCommand)
+		wantErr   string
+	}{
+		{
+			name:    "mode numeric",
+			topic:   "W/site01/vebus/257/Mode",
+			payload: `{"value":3}`,
+			assertion: func(t *testing.T, cmd writeCommand) {
+				assert.Equal(t, commandKindPanel, cmd.Kind)
+				assert.True(t, cmd.HasSwitch)
+				assert.Equal(t, mk2driver.PanelSwitchOn, cmd.SwitchState)
+				assert.Equal(t, "on", cmd.SwitchName)
+			},
+		},
+		{
+			name:    "current limit",
+			topic:   "W/site01/vebus/257/Ac/ActiveIn/CurrentLimit",
+			payload: `{"value":16.5}`,
+			assertion: func(t *testing.T, cmd writeCommand) {
+				assert.Equal(t, commandKindPanel, cmd.Kind)
+				if assert.NotNil(t, cmd.CurrentLimitA) {
+					assert.Equal(t, 16.5, *cmd.CurrentLimitA)
+				}
+			},
+		},
+		{
+			name:    "standby",
+			topic:   "W/site01/vebus/257/Settings/Standby",
+			payload: `{"value":true}`,
+			assertion: func(t *testing.T, cmd writeCommand) {
+				assert.Equal(t, commandKindStandby, cmd.Kind)
+				if assert.NotNil(t, cmd.Standby) {
+					assert.True(t, *cmd.Standby)
+				}
+			},
+		},
+		{
+			name:    "invalid topic",
+			topic:   "W/site01/vebus/257/Unknown",
+			payload: `{"value":1}`,
+			wantErr: "unsupported Venus write path",
+		},
+		{
+			name:    "guide ess setpoint",
+			topic:   "W/site01/settings/0/Settings/CGwacs/AcPowerSetPoint",
+			payload: `{"value":-1200}`,
+			assertion: func(t *testing.T, cmd writeCommand) {
+				assert.Equal(t, commandKindESSSet, cmd.Kind)
+				if assert.NotNil(t, cmd.FloatValue) {
+					assert.InDelta(t, -1200, *cmd.FloatValue, 0.01)
+				}
+			},
+		},
+		{
+			name:    "guide ess mode with prefix",
+			topic:   "victron/W/site01/settings/0/Settings/CGwacs/BatteryLife/State",
+			payload: `{"value":10}`,
+			assertion: func(t *testing.T, cmd writeCommand) {
+				assert.Equal(t, commandKindESSMode, cmd.Kind)
+				assert.Equal(t, int16(10), cmd.Value)
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			testCfg := cfg
+			if tt.name == "guide ess mode with prefix" {
+				testCfg.Venus.TopicPrefix = "victron"
+			}
+			cmd, err := decodeVenusWriteCommand(testCfg, tt.topic, []byte(tt.payload))
+			if tt.wantErr != "" {
+				assert.Error(t, err)
+				assert.ErrorContains(t, err, tt.wantErr)
+				return
+			}
+			assert.NoError(t, err)
+			tt.assertion(t, cmd)
+		})
+	}
+}
+
+func Test_panelStateCacheRememberTracksFields(t *testing.T) {
+	cache := &panelStateCache{}
+	limit := 12.0
+	standby := true
+
+	cache.remember(writeCommand{
+		Kind:          commandKindPanel,
+		HasSwitch:     true,
+		SwitchName:    "on",
+		SwitchState:   mk2driver.PanelSwitchOn,
+		CurrentLimitA: &limit,
+	})
+	cache.remember(writeCommand{
+		Kind:    commandKindStandby,
+		Standby: &standby,
+	})
+
+	s := cache.snapshot()
+	assert.True(t, s.HasSwitch)
+	assert.Equal(t, "on", s.Switch)
+	assert.True(t, s.HasCurrent)
+	assert.InDelta(t, 12.0, s.CurrentLimit, 0.001)
+	assert.True(t, s.HasStandby)
+	assert.True(t, s.Standby)
+}
+
+func Test_historyTrackerSummary(t *testing.T) {
+	h := newHistoryTracker(2)
+	now := time.Now().UTC()
+
+	h.Add(telemetrySnapshot{
+		Timestamp:      now,
+		InputPower:     100,
+		OutputPower:    90,
+		BatteryPower:   -10,
+		BatteryVoltage: 25.0,
+	}, operatingStatePassthru, 0, nil)
+	summary := h.Add(telemetrySnapshot{
+		Timestamp:      now.Add(1 * time.Second),
+		InputPower:     200,
+		OutputPower:    180,
+		BatteryPower:   -20,
+		BatteryVoltage: 24.5,
+	}, operatingStateInverter, 2, &now)
+
+	assert.Equal(t, 2, summary.Samples)
+	assert.InDelta(t, 150, summary.AverageInputPower, 0.01)
+	assert.InDelta(t, 135, summary.AverageOutputPower, 0.01)
+	assert.InDelta(t, 180, summary.MaxOutputPower, 0.01)
+	assert.InDelta(t, 24.5, summary.MinBatteryVoltage, 0.01)
+	assert.Equal(t, uint64(2), summary.FaultCount)
+}
+
+func Test_resolveESSWriteCommand(t *testing.T) {
+	ess := newESSControlCache()
+	telemetry := &telemetryCache{}
+	telemetry.set(telemetrySnapshot{InputVoltage: 230})
+
+	setpoint := 920.0
+	mapped, err := resolveESSWriteCommand(writeCommand{
+		Kind:       commandKindESSSet,
+		FloatValue: &setpoint,
+	}, ess, telemetry)
+	assert.NoError(t, err)
+	if assert.NotNil(t, mapped) {
+		assert.Equal(t, commandKindPanel, mapped.Kind)
+		assert.Equal(t, "charger_only", mapped.SwitchName)
+		if assert.NotNil(t, mapped.CurrentLimitA) {
+			assert.InDelta(t, 4.0, *mapped.CurrentLimitA, 0.01)
+		}
+	}
+
+	maxDischarge := 1000.0
+	_, err = resolveESSWriteCommand(writeCommand{
+		Kind:       commandKindESSMaxD,
+		FloatValue: &maxDischarge,
+	}, ess, telemetry)
+	assert.NoError(t, err)
+
+	dischargeSetpoint := -2000.0
+	mapped, err = resolveESSWriteCommand(writeCommand{
+		Kind:       commandKindESSSet,
+		FloatValue: &dischargeSetpoint,
+	}, ess, telemetry)
+	assert.NoError(t, err)
+	if assert.NotNil(t, mapped) {
+		assert.Equal(t, commandKindPanel, mapped.Kind)
+		assert.Equal(t, "inverter_only", mapped.SwitchName)
+	}
+}

plugins/munin/munin.go

@@ -36,7 +36,7 @@ import (
 	"net/http"
 	"time"
 
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
 	"github.com/sirupsen/logrus"
 )
 

plugins/munin/munin_test.go

@@ -6,7 +6,7 @@ import (
 	"net/http/httptest"
 	"testing"
 
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
 )
 
 func TestServer(_ *testing.T) {

plugins/prometheus/prometheus.go

@@ -31,7 +31,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 package prometheus
 
 import (
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
 	"github.com/prometheus/client_golang/prometheus"
 )
 

plugins/webui/webgui.go

@@ -38,8 +38,8 @@ import (
 	"sync"
 	"time"
 
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
-	"invertergui/websocket"
+	"git.coadcorp.com/nathan/invertergui/websocket"
 	"github.com/sirupsen/logrus"
 )
 
@@ -85,6 +85,7 @@ func NewWebGui(source mk2driver.Mk2, writer mk2driver.SettingsWriter) *WebGui {
 			Mode:     modeUnknown,
 		},
 	}
+	log.WithField("remote_writable", writer != nil).Info("Web UI initialized")
 	w.wg.Add(1)
 	go w.dataPoll()
 	return w
@@ -138,55 +139,88 @@ type setRemotePanelStandbyRequest struct {
 }
 
 func (w *WebGui) ServeHub(rw http.ResponseWriter, r *http.Request) {
+	log.WithFields(logrus.Fields{
+		"remote": r.RemoteAddr,
+		"path":   r.URL.Path,
+	}).Debug("WebSocket hub request")
 	w.hub.ServeHTTP(rw, r)
 }
 
 func (w *WebGui) ServeRemotePanelState(rw http.ResponseWriter, r *http.Request) {
+	log.WithFields(logrus.Fields{
+		"method": r.Method,
+		"path":   r.URL.Path,
+		"remote": r.RemoteAddr,
+	}).Debug("Remote panel state API request")
+
 	switch r.Method {
 	case http.MethodGet:
 		writeJSON(rw, http.StatusOK, w.getRemotePanelState())
 	case http.MethodPost:
 		w.handleSetRemotePanelState(rw, r)
 	default:
+		log.WithField("method", r.Method).Warn("Remote panel state API received unsupported method")
 		http.Error(rw, "method not allowed", http.StatusMethodNotAllowed)
 	}
 }
 
 func (w *WebGui) ServeRemotePanelStandby(rw http.ResponseWriter, r *http.Request) {
+	log.WithFields(logrus.Fields{
+		"method": r.Method,
+		"path":   r.URL.Path,
+		"remote": r.RemoteAddr,
+	}).Debug("Remote panel standby API request")
+
 	switch r.Method {
 	case http.MethodGet:
 		writeJSON(rw, http.StatusOK, w.getRemotePanelState())
 	case http.MethodPost:
 		w.handleSetRemotePanelStandby(rw, r)
 	default:
+		log.WithField("method", r.Method).Warn("Remote panel standby API received unsupported method")
 		http.Error(rw, "method not allowed", http.StatusMethodNotAllowed)
 	}
 }
 
 func (w *WebGui) handleSetRemotePanelState(rw http.ResponseWriter, r *http.Request) {
 	if w.writer == nil {
+		log.Warn("Remote panel state write requested, but writer is unavailable")
 		http.Error(rw, "remote control is not supported by this data source", http.StatusNotImplemented)
 		return
 	}
 
 	req := setRemotePanelStateRequest{}
 	if err := decodeJSONBody(r, &req); err != nil {
+		log.WithError(err).Warn("Invalid remote panel state request body")
 		http.Error(rw, err.Error(), http.StatusBadRequest)
 		return
 	}
+	logEntry := log.WithField("mode", req.Mode)
+	if req.CurrentLimit != nil {
+		logEntry = logEntry.WithField("current_limit_a", *req.CurrentLimit)
+	}
+	logEntry.Info("Applying remote panel state from API")
 
 	switchState, normalizedMode, err := parsePanelMode(req.Mode)
 	if err != nil {
+		logEntry.WithError(err).Warn("Unsupported remote panel mode")
 		http.Error(rw, err.Error(), http.StatusBadRequest)
 		return
 	}
 
-	if err := w.writer.SetPanelState(switchState, req.CurrentLimit); err != nil {
+	var setErr error
+	if sourceAware, ok := w.writer.(mk2driver.SourceAwareSettingsWriter); ok {
+		setErr = sourceAware.SetPanelStateWithSource(mk2driver.CommandSourceUI, switchState, req.CurrentLimit)
+	} else {
+		setErr = w.writer.SetPanelState(switchState, req.CurrentLimit)
+	}
+	if setErr != nil {
+		logEntry.WithError(setErr).Error("Failed to apply remote panel state")
 		w.updateRemotePanelState(func(state *remotePanelState) {
 			state.LastCommand = "set_remote_panel_state"
-			state.LastError = err.Error()
+			state.LastError = setErr.Error()
 		})
-		http.Error(rw, err.Error(), http.StatusBadGateway)
+		http.Error(rw, setErr.Error(), http.StatusBadGateway)
 		return
 	}
 
@@ -196,22 +230,33 @@ func (w *WebGui) handleSetRemotePanelState(rw http.ResponseWriter, r *http.Reque
 		state.LastCommand = "set_remote_panel_state"
 		state.LastError = ""
 	})
+	logEntry.WithField("normalized_mode", normalizedMode).Info("Remote panel state applied")
 	writeJSON(rw, http.StatusOK, w.getRemotePanelState())
 }
 
 func (w *WebGui) handleSetRemotePanelStandby(rw http.ResponseWriter, r *http.Request) {
 	if w.writer == nil {
+		log.Warn("Remote panel standby write requested, but writer is unavailable")
 		http.Error(rw, "remote control is not supported by this data source", http.StatusNotImplemented)
 		return
 	}
 
 	req := setRemotePanelStandbyRequest{}
 	if err := decodeJSONBody(r, &req); err != nil {
+		log.WithError(err).Warn("Invalid remote panel standby request body")
 		http.Error(rw, err.Error(), http.StatusBadRequest)
 		return
 	}
+	log.WithField("standby", req.Standby).Info("Applying standby state from API")
 
-	if err := w.writer.SetStandby(req.Standby); err != nil {
+	var err error
+	if sourceAware, ok := w.writer.(mk2driver.SourceAwareSettingsWriter); ok {
+		err = sourceAware.SetStandbyWithSource(mk2driver.CommandSourceUI, req.Standby)
+	} else {
+		err = w.writer.SetStandby(req.Standby)
+	}
+	if err != nil {
+		log.WithError(err).WithField("standby", req.Standby).Error("Failed to apply standby state")
 		w.updateRemotePanelState(func(state *remotePanelState) {
 			state.LastCommand = "set_remote_panel_standby"
 			state.LastError = err.Error()
@@ -225,6 +270,7 @@ func (w *WebGui) handleSetRemotePanelStandby(rw http.ResponseWriter, r *http.Req
 		state.LastCommand = "set_remote_panel_standby"
 		state.LastError = ""
 	})
+	log.WithField("standby", req.Standby).Info("Standby state applied")
 	writeJSON(rw, http.StatusOK, w.getRemotePanelState())
 }
 
@@ -301,23 +347,32 @@ func buildTemplateInput(status *mk2driver.Mk2Info) *templateInput {
 }
 
 func (w *WebGui) Stop() {
+	log.Info("Stopping Web UI polling")
 	close(w.stopChan)
 	w.wg.Wait()
+	log.Info("Web UI polling stopped")
 }
 
 func (w *WebGui) dataPoll() {
 	for {
 		select {
 		case s := <-w.C():
-			if s.Valid {
+			if s == nil {
-				payload := buildTemplateInput(s)
+				log.Debug("Skipping nil MK2 update in Web UI poller")
-				w.stateMu.Lock()
+				continue
-				payload.RemotePanel = w.remote
+			}
-				w.latest = payload
+			if !s.Valid {
-				w.stateMu.Unlock()
+				log.WithField("errors", len(s.Errors)).Debug("Skipping invalid MK2 update in Web UI poller")
-				if err := w.hub.Broadcast(payload); err != nil {
+				continue
-					log.Errorf("Could not send update to clients: %v", err)
+			}
-				}
+
+			payload := buildTemplateInput(s)
+			w.stateMu.Lock()
+			payload.RemotePanel = w.remote
+			w.latest = payload
+			w.stateMu.Unlock()
+			if err := w.hub.Broadcast(payload); err != nil {
+				log.Errorf("Could not send update to clients: %v", err)
 			}
 		case <-w.stopChan:
 			w.wg.Done()
@@ -336,6 +391,13 @@ func (w *WebGui) updateRemotePanelState(update func(state *remotePanelState)) {
 	w.stateMu.Lock()
 	update(&w.remote)
 	w.remote.LastUpdated = time.Now().UTC().Format(time.RFC3339)
+	log.WithFields(logrus.Fields{
+		"mode":         w.remote.Mode,
+		"has_limit":    w.remote.CurrentLimit != nil,
+		"has_standby":  w.remote.Standby != nil,
+		"last_command": w.remote.LastCommand,
+		"last_error":   w.remote.LastError,
+	}).Debug("Updated remote panel state cache")
 	snapshot := w.snapshotLocked()
 	w.stateMu.Unlock()
 

plugins/webui/webgui_test.go

@@ -36,7 +36,7 @@ import (
 	"testing"
 	"time"
 
-	"invertergui/mk2driver"
+	"git.coadcorp.com/nathan/invertergui/mk2driver"
 )
 
 type templateTest struct {

vendor/github.com/beorn7/perks/LICENSE

@@ -1,20 +0,0 @@
-Copyright (C) 2013 Blake Mizerany
-
-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.

vendor/github.com/beorn7/perks/quantile/stream.go

@@ -1,316 +0,0 @@
-// Package quantile computes approximate quantiles over an unbounded data
-// stream within low memory and CPU bounds.
-//
-// A small amount of accuracy is traded to achieve the above properties.
-//
-// Multiple streams can be merged before calling Query to generate a single set
-// of results. This is meaningful when the streams represent the same type of
-// data. See Merge and Samples.
-//
-// For more detailed information about the algorithm used, see:
-//
-// Effective Computation of Biased Quantiles over Data Streams
-//
-// http://www.cs.rutgers.edu/~muthu/bquant.pdf
-package quantile
-
-import (
-	"math"
-	"sort"
-)
-
-// Sample holds an observed value and meta information for compression. JSON
-// tags have been added for convenience.
-type Sample struct {
-	Value float64 `json:",string"`
-	Width float64 `json:",string"`
-	Delta float64 `json:",string"`
-}
-
-// Samples represents a slice of samples. It implements sort.Interface.
-type Samples []Sample
-
-func (a Samples) Len() int           { return len(a) }
-func (a Samples) Less(i, j int) bool { return a[i].Value < a[j].Value }
-func (a Samples) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
-
-type invariant func(s *stream, r float64) float64
-
-// NewLowBiased returns an initialized Stream for low-biased quantiles
-// (e.g. 0.01, 0.1, 0.5) where the needed quantiles are not known a priori, but
-// error guarantees can still be given even for the lower ranks of the data
-// distribution.
-//
-// The provided epsilon is a relative error, i.e. the true quantile of a value
-// returned by a query is guaranteed to be within (1±Epsilon)*Quantile.
-//
-// See http://www.cs.rutgers.edu/~muthu/bquant.pdf for time, space, and error
-// properties.
-func NewLowBiased(epsilon float64) *Stream {
-	ƒ := func(s *stream, r float64) float64 {
-		return 2 * epsilon * r
-	}
-	return newStream(ƒ)
-}
-
-// NewHighBiased returns an initialized Stream for high-biased quantiles
-// (e.g. 0.01, 0.1, 0.5) where the needed quantiles are not known a priori, but
-// error guarantees can still be given even for the higher ranks of the data
-// distribution.
-//
-// The provided epsilon is a relative error, i.e. the true quantile of a value
-// returned by a query is guaranteed to be within 1-(1±Epsilon)*(1-Quantile).
-//
-// See http://www.cs.rutgers.edu/~muthu/bquant.pdf for time, space, and error
-// properties.
-func NewHighBiased(epsilon float64) *Stream {
-	ƒ := func(s *stream, r float64) float64 {
-		return 2 * epsilon * (s.n - r)
-	}
-	return newStream(ƒ)
-}
-
-// NewTargeted returns an initialized Stream concerned with a particular set of
-// quantile values that are supplied a priori. Knowing these a priori reduces
-// space and computation time. The targets map maps the desired quantiles to
-// their absolute errors, i.e. the true quantile of a value returned by a query
-// is guaranteed to be within (Quantile±Epsilon).
-//
-// See http://www.cs.rutgers.edu/~muthu/bquant.pdf for time, space, and error properties.
-func NewTargeted(targetMap map[float64]float64) *Stream {
-	// Convert map to slice to avoid slow iterations on a map.
-	// ƒ is called on the hot path, so converting the map to a slice
-	// beforehand results in significant CPU savings.
-	targets := targetMapToSlice(targetMap)
-
-	ƒ := func(s *stream, r float64) float64 {
-		var m = math.MaxFloat64
-		var f float64
-		for _, t := range targets {
-			if t.quantile*s.n <= r {
-				f = (2 * t.epsilon * r) / t.quantile
-			} else {
-				f = (2 * t.epsilon * (s.n - r)) / (1 - t.quantile)
-			}
-			if f < m {
-				m = f
-			}
-		}
-		return m
-	}
-	return newStream(ƒ)
-}
-
-type target struct {
-	quantile float64
-	epsilon  float64
-}
-
-func targetMapToSlice(targetMap map[float64]float64) []target {
-	targets := make([]target, 0, len(targetMap))
-
-	for quantile, epsilon := range targetMap {
-		t := target{
-			quantile: quantile,
-			epsilon:  epsilon,
-		}
-		targets = append(targets, t)
-	}
-
-	return targets
-}
-
-// Stream computes quantiles for a stream of float64s. It is not thread-safe by
-// design. Take care when using across multiple goroutines.
-type Stream struct {
-	*stream
-	b      Samples
-	sorted bool
-}
-
-func newStream(ƒ invariant) *Stream {
-	x := &stream{ƒ: ƒ}
-	return &Stream{x, make(Samples, 0, 500), true}
-}
-
-// Insert inserts v into the stream.
-func (s *Stream) Insert(v float64) {
-	s.insert(Sample{Value: v, Width: 1})
-}
-
-func (s *Stream) insert(sample Sample) {
-	s.b = append(s.b, sample)
-	s.sorted = false
-	if len(s.b) == cap(s.b) {
-		s.flush()
-	}
-}
-
-// Query returns the computed qth percentiles value. If s was created with
-// NewTargeted, and q is not in the set of quantiles provided a priori, Query
-// will return an unspecified result.
-func (s *Stream) Query(q float64) float64 {
-	if !s.flushed() {
-		// Fast path when there hasn't been enough data for a flush;
-		// this also yields better accuracy for small sets of data.
-		l := len(s.b)
-		if l == 0 {
-			return 0
-		}
-		i := int(math.Ceil(float64(l) * q))
-		if i > 0 {
-			i -= 1
-		}
-		s.maybeSort()
-		return s.b[i].Value
-	}
-	s.flush()
-	return s.stream.query(q)
-}
-
-// Merge merges samples into the underlying streams samples. This is handy when
-// merging multiple streams from separate threads, database shards, etc.
-//
-// ATTENTION: This method is broken and does not yield correct results. The
-// underlying algorithm is not capable of merging streams correctly.
-func (s *Stream) Merge(samples Samples) {
-	sort.Sort(samples)
-	s.stream.merge(samples)
-}
-
-// Reset reinitializes and clears the list reusing the samples buffer memory.
-func (s *Stream) Reset() {
-	s.stream.reset()
-	s.b = s.b[:0]
-}
-
-// Samples returns stream samples held by s.
-func (s *Stream) Samples() Samples {
-	if !s.flushed() {
-		return s.b
-	}
-	s.flush()
-	return s.stream.samples()
-}
-
-// Count returns the total number of samples observed in the stream
-// since initialization.
-func (s *Stream) Count() int {
-	return len(s.b) + s.stream.count()
-}
-
-func (s *Stream) flush() {
-	s.maybeSort()
-	s.stream.merge(s.b)
-	s.b = s.b[:0]
-}
-
-func (s *Stream) maybeSort() {
-	if !s.sorted {
-		s.sorted = true
-		sort.Sort(s.b)
-	}
-}
-
-func (s *Stream) flushed() bool {
-	return len(s.stream.l) > 0
-}
-
-type stream struct {
-	n float64
-	l []Sample
-	ƒ invariant
-}
-
-func (s *stream) reset() {
-	s.l = s.l[:0]
-	s.n = 0
-}
-
-func (s *stream) insert(v float64) {
-	s.merge(Samples{{v, 1, 0}})
-}
-
-func (s *stream) merge(samples Samples) {
-	// TODO(beorn7): This tries to merge not only individual samples, but
-	// whole summaries. The paper doesn't mention merging summaries at
-	// all. Unittests show that the merging is inaccurate. Find out how to
-	// do merges properly.
-	var r float64
-	i := 0
-	for _, sample := range samples {
-		for ; i < len(s.l); i++ {
-			c := s.l[i]
-			if c.Value > sample.Value {
-				// Insert at position i.
-				s.l = append(s.l, Sample{})
-				copy(s.l[i+1:], s.l[i:])
-				s.l[i] = Sample{
-					sample.Value,
-					sample.Width,
-					math.Max(sample.Delta, math.Floor(s.ƒ(s, r))-1),
-					// TODO(beorn7): How to calculate delta correctly?
-				}
-				i++
-				goto inserted
-			}
-			r += c.Width
-		}
-		s.l = append(s.l, Sample{sample.Value, sample.Width, 0})
-		i++
-	inserted:
-		s.n += sample.Width
-		r += sample.Width
-	}
-	s.compress()
-}
-
-func (s *stream) count() int {
-	return int(s.n)
-}
-
-func (s *stream) query(q float64) float64 {
-	t := math.Ceil(q * s.n)
-	t += math.Ceil(s.ƒ(s, t) / 2)
-	p := s.l[0]
-	var r float64
-	for _, c := range s.l[1:] {
-		r += p.Width
-		if r+c.Width+c.Delta > t {
-			return p.Value
-		}
-		p = c
-	}
-	return p.Value
-}
-
-func (s *stream) compress() {
-	if len(s.l) < 2 {
-		return
-	}
-	x := s.l[len(s.l)-1]
-	xi := len(s.l) - 1
-	r := s.n - 1 - x.Width
-
-	for i := len(s.l) - 2; i >= 0; i-- {
-		c := s.l[i]
-		if c.Width+x.Width+x.Delta <= s.ƒ(s, r) {
-			x.Width += c.Width
-			s.l[xi] = x
-			// Remove element at i.
-			copy(s.l[i:], s.l[i+1:])
-			s.l = s.l[:len(s.l)-1]
-			xi -= 1
-		} else {
-			x = c
-			xi = i
-		}
-		r -= c.Width
-	}
-}
-
-func (s *stream) samples() Samples {
-	samples := make(Samples, len(s.l))
-	copy(samples, s.l)
-	return samples
-}

vendor/github.com/cespare/xxhash/v2/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2016 Caleb Spare
-
-MIT License
-
-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.

vendor/github.com/cespare/xxhash/v2/README.md

@@ -1,74 +0,0 @@
-# xxhash
-
-[![Go Reference](https://pkg.go.dev/badge/github.com/cespare/xxhash/v2.svg)](https://pkg.go.dev/github.com/cespare/xxhash/v2)
-[![Test](https://github.com/cespare/xxhash/actions/workflows/test.yml/badge.svg)](https://github.com/cespare/xxhash/actions/workflows/test.yml)
-
-xxhash is a Go implementation of the 64-bit [xxHash] algorithm, XXH64. This is a
-high-quality hashing algorithm that is much faster than anything in the Go
-standard library.
-
-This package provides a straightforward API:
-
-```
-func Sum64(b []byte) uint64
-func Sum64String(s string) uint64
-type Digest struct{ ... }
-    func New() *Digest
-```
-
-The `Digest` type implements hash.Hash64. Its key methods are:
-
-```
-func (*Digest) Write([]byte) (int, error)
-func (*Digest) WriteString(string) (int, error)
-func (*Digest) Sum64() uint64
-```
-
-The package is written with optimized pure Go and also contains even faster
-assembly implementations for amd64 and arm64. If desired, the `purego` build tag
-opts into using the Go code even on those architectures.
-
-[xxHash]: http://cyan4973.github.io/xxHash/
-
-## Compatibility
-
-This package is in a module and the latest code is in version 2 of the module.
-You need a version of Go with at least "minimal module compatibility" to use
-github.com/cespare/xxhash/v2:
-
-* 1.9.7+ for Go 1.9
-* 1.10.3+ for Go 1.10
-* Go 1.11 or later
-
-I recommend using the latest release of Go.
-
-## Benchmarks
-
-Here are some quick benchmarks comparing the pure-Go and assembly
-implementations of Sum64.
-
-| input size | purego    | asm       |
-| ---------- | --------- | --------- |
-| 4 B        |  1.3 GB/s |  1.2 GB/s |
-| 16 B       |  2.9 GB/s |  3.5 GB/s |
-| 100 B      |  6.9 GB/s |  8.1 GB/s |
-| 4 KB       | 11.7 GB/s | 16.7 GB/s |
-| 10 MB      | 12.0 GB/s | 17.3 GB/s |
-
-These numbers were generated on Ubuntu 20.04 with an Intel Xeon Platinum 8252C
-CPU using the following commands under Go 1.19.2:
-
-```
-benchstat <(go test -tags purego -benchtime 500ms -count 15 -bench 'Sum64$')
-benchstat <(go test -benchtime 500ms -count 15 -bench 'Sum64$')
-```
-
-## Projects using this package
-
-- [InfluxDB](https://github.com/influxdata/influxdb)
-- [Prometheus](https://github.com/prometheus/prometheus)
-- [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics)
-- [FreeCache](https://github.com/coocood/freecache)
-- [FastCache](https://github.com/VictoriaMetrics/fastcache)
-- [Ristretto](https://github.com/dgraph-io/ristretto)
-- [Badger](https://github.com/dgraph-io/badger)

vendor/github.com/cespare/xxhash/v2/testall.sh

@@ -1,10 +0,0 @@
-#!/bin/bash
-set -eu -o pipefail
-
-# Small convenience script for running the tests with various combinations of
-# arch/tags. This assumes we're running on amd64 and have qemu available.
-
-go test ./...
-go test -tags purego ./...
-GOARCH=arm64 go test
-GOARCH=arm64 go test -tags purego

vendor/github.com/cespare/xxhash/v2/xxhash.go

@@ -1,243 +0,0 @@
-// Package xxhash implements the 64-bit variant of xxHash (XXH64) as described
-// at http://cyan4973.github.io/xxHash/.
-package xxhash
-
-import (
-	"encoding/binary"
-	"errors"
-	"math/bits"
-)
-
-const (
-	prime1 uint64 = 11400714785074694791
-	prime2 uint64 = 14029467366897019727
-	prime3 uint64 = 1609587929392839161
-	prime4 uint64 = 9650029242287828579
-	prime5 uint64 = 2870177450012600261
-)
-
-// Store the primes in an array as well.
-//
-// The consts are used when possible in Go code to avoid MOVs but we need a
-// contiguous array for the assembly code.
-var primes = [...]uint64{prime1, prime2, prime3, prime4, prime5}
-
-// Digest implements hash.Hash64.
-//
-// Note that a zero-valued Digest is not ready to receive writes.
-// Call Reset or create a Digest using New before calling other methods.
-type Digest struct {
-	v1    uint64
-	v2    uint64
-	v3    uint64
-	v4    uint64
-	total uint64
-	mem   [32]byte
-	n     int // how much of mem is used
-}
-
-// New creates a new Digest with a zero seed.
-func New() *Digest {
-	return NewWithSeed(0)
-}
-
-// NewWithSeed creates a new Digest with the given seed.
-func NewWithSeed(seed uint64) *Digest {
-	var d Digest
-	d.ResetWithSeed(seed)
-	return &d
-}
-
-// Reset clears the Digest's state so that it can be reused.
-// It uses a seed value of zero.
-func (d *Digest) Reset() {
-	d.ResetWithSeed(0)
-}
-
-// ResetWithSeed clears the Digest's state so that it can be reused.
-// It uses the given seed to initialize the state.
-func (d *Digest) ResetWithSeed(seed uint64) {
-	d.v1 = seed + prime1 + prime2
-	d.v2 = seed + prime2
-	d.v3 = seed
-	d.v4 = seed - prime1
-	d.total = 0
-	d.n = 0
-}
-
-// Size always returns 8 bytes.
-func (d *Digest) Size() int { return 8 }
-
-// BlockSize always returns 32 bytes.
-func (d *Digest) BlockSize() int { return 32 }
-
-// Write adds more data to d. It always returns len(b), nil.
-func (d *Digest) Write(b []byte) (n int, err error) {
-	n = len(b)
-	d.total += uint64(n)
-
-	memleft := d.mem[d.n&(len(d.mem)-1):]
-
-	if d.n+n < 32 {
-		// This new data doesn't even fill the current block.
-		copy(memleft, b)
-		d.n += n
-		return
-	}
-
-	if d.n > 0 {
-		// Finish off the partial block.
-		c := copy(memleft, b)
-		d.v1 = round(d.v1, u64(d.mem[0:8]))
-		d.v2 = round(d.v2, u64(d.mem[8:16]))
-		d.v3 = round(d.v3, u64(d.mem[16:24]))
-		d.v4 = round(d.v4, u64(d.mem[24:32]))
-		b = b[c:]
-		d.n = 0
-	}
-
-	if len(b) >= 32 {
-		// One or more full blocks left.
-		nw := writeBlocks(d, b)
-		b = b[nw:]
-	}
-
-	// Store any remaining partial block.
-	copy(d.mem[:], b)
-	d.n = len(b)
-
-	return
-}
-
-// Sum appends the current hash to b and returns the resulting slice.
-func (d *Digest) Sum(b []byte) []byte {
-	s := d.Sum64()
-	return append(
-		b,
-		byte(s>>56),
-		byte(s>>48),
-		byte(s>>40),
-		byte(s>>32),
-		byte(s>>24),
-		byte(s>>16),
-		byte(s>>8),
-		byte(s),
-	)
-}
-
-// Sum64 returns the current hash.
-func (d *Digest) Sum64() uint64 {
-	var h uint64
-
-	if d.total >= 32 {
-		v1, v2, v3, v4 := d.v1, d.v2, d.v3, d.v4
-		h = rol1(v1) + rol7(v2) + rol12(v3) + rol18(v4)
-		h = mergeRound(h, v1)
-		h = mergeRound(h, v2)
-		h = mergeRound(h, v3)
-		h = mergeRound(h, v4)
-	} else {
-		h = d.v3 + prime5
-	}
-
-	h += d.total
-
-	b := d.mem[:d.n&(len(d.mem)-1)]
-	for ; len(b) >= 8; b = b[8:] {
-		k1 := round(0, u64(b[:8]))
-		h ^= k1
-		h = rol27(h)*prime1 + prime4
-	}
-	if len(b) >= 4 {
-		h ^= uint64(u32(b[:4])) * prime1
-		h = rol23(h)*prime2 + prime3
-		b = b[4:]
-	}
-	for ; len(b) > 0; b = b[1:] {
-		h ^= uint64(b[0]) * prime5
-		h = rol11(h) * prime1
-	}
-
-	h ^= h >> 33
-	h *= prime2
-	h ^= h >> 29
-	h *= prime3
-	h ^= h >> 32
-
-	return h
-}
-
-const (
-	magic         = "xxh\x06"
-	marshaledSize = len(magic) + 8*5 + 32
-)
-
-// MarshalBinary implements the encoding.BinaryMarshaler interface.
-func (d *Digest) MarshalBinary() ([]byte, error) {
-	b := make([]byte, 0, marshaledSize)
-	b = append(b, magic...)
-	b = appendUint64(b, d.v1)
-	b = appendUint64(b, d.v2)
-	b = appendUint64(b, d.v3)
-	b = appendUint64(b, d.v4)
-	b = appendUint64(b, d.total)
-	b = append(b, d.mem[:d.n]...)
-	b = b[:len(b)+len(d.mem)-d.n]
-	return b, nil
-}
-
-// UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.
-func (d *Digest) UnmarshalBinary(b []byte) error {
-	if len(b) < len(magic) || string(b[:len(magic)]) != magic {
-		return errors.New("xxhash: invalid hash state identifier")
-	}
-	if len(b) != marshaledSize {
-		return errors.New("xxhash: invalid hash state size")
-	}
-	b = b[len(magic):]
-	b, d.v1 = consumeUint64(b)
-	b, d.v2 = consumeUint64(b)
-	b, d.v3 = consumeUint64(b)
-	b, d.v4 = consumeUint64(b)
-	b, d.total = consumeUint64(b)
-	copy(d.mem[:], b)
-	d.n = int(d.total % uint64(len(d.mem)))
-	return nil
-}
-
-func appendUint64(b []byte, x uint64) []byte {
-	var a [8]byte
-	binary.LittleEndian.PutUint64(a[:], x)
-	return append(b, a[:]...)
-}
-
-func consumeUint64(b []byte) ([]byte, uint64) {
-	x := u64(b)
-	return b[8:], x
-}
-
-func u64(b []byte) uint64 { return binary.LittleEndian.Uint64(b) }
-func u32(b []byte) uint32 { return binary.LittleEndian.Uint32(b) }
-
-func round(acc, input uint64) uint64 {
-	acc += input * prime2
-	acc = rol31(acc)
-	acc *= prime1
-	return acc
-}
-
-func mergeRound(acc, val uint64) uint64 {
-	val = round(0, val)
-	acc ^= val
-	acc = acc*prime1 + prime4
-	return acc
-}
-
-func rol1(x uint64) uint64  { return bits.RotateLeft64(x, 1) }
-func rol7(x uint64) uint64  { return bits.RotateLeft64(x, 7) }
-func rol11(x uint64) uint64 { return bits.RotateLeft64(x, 11) }
-func rol12(x uint64) uint64 { return bits.RotateLeft64(x, 12) }
-func rol18(x uint64) uint64 { return bits.RotateLeft64(x, 18) }
-func rol23(x uint64) uint64 { return bits.RotateLeft64(x, 23) }
-func rol27(x uint64) uint64 { return bits.RotateLeft64(x, 27) }
-func rol31(x uint64) uint64 { return bits.RotateLeft64(x, 31) }

vendor/github.com/cespare/xxhash/v2/xxhash_amd64.s

@@ -1,209 +0,0 @@
-//go:build !appengine && gc && !purego
-// +build !appengine
-// +build gc
-// +build !purego
-
-#include "textflag.h"
-
-// Registers:
-#define h      AX
-#define d      AX
-#define p      SI // pointer to advance through b
-#define n      DX
-#define end    BX // loop end
-#define v1     R8
-#define v2     R9
-#define v3     R10
-#define v4     R11
-#define x      R12
-#define prime1 R13
-#define prime2 R14
-#define prime4 DI
-
-#define round(acc, x) \
-	IMULQ prime2, x   \
-	ADDQ  x, acc      \
-	ROLQ  $31, acc    \
-	IMULQ prime1, acc
-
-// round0 performs the operation x = round(0, x).
-#define round0(x) \
-	IMULQ prime2, x \
-	ROLQ  $31, x    \
-	IMULQ prime1, x
-
-// mergeRound applies a merge round on the two registers acc and x.
-// It assumes that prime1, prime2, and prime4 have been loaded.
-#define mergeRound(acc, x) \
-	round0(x)         \
-	XORQ  x, acc      \
-	IMULQ prime1, acc \
-	ADDQ  prime4, acc
-
-// blockLoop processes as many 32-byte blocks as possible,
-// updating v1, v2, v3, and v4. It assumes that there is at least one block
-// to process.
-#define blockLoop() \
-loop:  \
-	MOVQ +0(p), x  \
-	round(v1, x)   \
-	MOVQ +8(p), x  \
-	round(v2, x)   \
-	MOVQ +16(p), x \
-	round(v3, x)   \
-	MOVQ +24(p), x \
-	round(v4, x)   \
-	ADDQ $32, p    \
-	CMPQ p, end    \
-	JLE  loop
-
-// func Sum64(b []byte) uint64
-TEXT ·Sum64(SB), NOSPLIT|NOFRAME, $0-32
-	// Load fixed primes.
-	MOVQ ·primes+0(SB), prime1
-	MOVQ ·primes+8(SB), prime2
-	MOVQ ·primes+24(SB), prime4
-
-	// Load slice.
-	MOVQ b_base+0(FP), p
-	MOVQ b_len+8(FP), n
-	LEAQ (p)(n*1), end
-
-	// The first loop limit will be len(b)-32.
-	SUBQ $32, end
-
-	// Check whether we have at least one block.
-	CMPQ n, $32
-	JLT  noBlocks
-
-	// Set up initial state (v1, v2, v3, v4).
-	MOVQ prime1, v1
-	ADDQ prime2, v1
-	MOVQ prime2, v2
-	XORQ v3, v3
-	XORQ v4, v4
-	SUBQ prime1, v4
-
-	blockLoop()
-
-	MOVQ v1, h
-	ROLQ $1, h
-	MOVQ v2, x
-	ROLQ $7, x
-	ADDQ x, h
-	MOVQ v3, x
-	ROLQ $12, x
-	ADDQ x, h
-	MOVQ v4, x
-	ROLQ $18, x
-	ADDQ x, h
-
-	mergeRound(h, v1)
-	mergeRound(h, v2)
-	mergeRound(h, v3)
-	mergeRound(h, v4)
-
-	JMP afterBlocks
-
-noBlocks:
-	MOVQ ·primes+32(SB), h
-
-afterBlocks:
-	ADDQ n, h
-
-	ADDQ $24, end
-	CMPQ p, end
-	JG   try4
-
-loop8:
-	MOVQ  (p), x
-	ADDQ  $8, p
-	round0(x)
-	XORQ  x, h
-	ROLQ  $27, h
-	IMULQ prime1, h
-	ADDQ  prime4, h
-
-	CMPQ p, end
-	JLE  loop8
-
-try4:
-	ADDQ $4, end
-	CMPQ p, end
-	JG   try1
-
-	MOVL  (p), x
-	ADDQ  $4, p
-	IMULQ prime1, x
-	XORQ  x, h
-
-	ROLQ  $23, h
-	IMULQ prime2, h
-	ADDQ  ·primes+16(SB), h
-
-try1:
-	ADDQ $4, end
-	CMPQ p, end
-	JGE  finalize
-
-loop1:
-	MOVBQZX (p), x
-	ADDQ    $1, p
-	IMULQ   ·primes+32(SB), x
-	XORQ    x, h
-	ROLQ    $11, h
-	IMULQ   prime1, h
-
-	CMPQ p, end
-	JL   loop1
-
-finalize:
-	MOVQ  h, x
-	SHRQ  $33, x
-	XORQ  x, h
-	IMULQ prime2, h
-	MOVQ  h, x
-	SHRQ  $29, x
-	XORQ  x, h
-	IMULQ ·primes+16(SB), h
-	MOVQ  h, x
-	SHRQ  $32, x
-	XORQ  x, h
-
-	MOVQ h, ret+24(FP)
-	RET
-
-// func writeBlocks(d *Digest, b []byte) int
-TEXT ·writeBlocks(SB), NOSPLIT|NOFRAME, $0-40
-	// Load fixed primes needed for round.
-	MOVQ ·primes+0(SB), prime1
-	MOVQ ·primes+8(SB), prime2
-
-	// Load slice.
-	MOVQ b_base+8(FP), p
-	MOVQ b_len+16(FP), n
-	LEAQ (p)(n*1), end
-	SUBQ $32, end
-
-	// Load vN from d.
-	MOVQ s+0(FP), d
-	MOVQ 0(d), v1
-	MOVQ 8(d), v2
-	MOVQ 16(d), v3
-	MOVQ 24(d), v4
-
-	// We don't need to check the loop condition here; this function is
-	// always called with at least one block of data to process.
-	blockLoop()
-
-	// Copy vN back to d.
-	MOVQ v1, 0(d)
-	MOVQ v2, 8(d)
-	MOVQ v3, 16(d)
-	MOVQ v4, 24(d)
-
-	// The number of bytes written is p minus the old base pointer.
-	SUBQ b_base+8(FP), p
-	MOVQ p, ret+32(FP)
-
-	RET

vendor/github.com/cespare/xxhash/v2/xxhash_arm64.s

@@ -1,183 +0,0 @@
-//go:build !appengine && gc && !purego
-// +build !appengine
-// +build gc
-// +build !purego
-
-#include "textflag.h"
-
-// Registers:
-#define digest	R1
-#define h	R2 // return value
-#define p	R3 // input pointer
-#define n	R4 // input length
-#define nblocks	R5 // n / 32
-#define prime1	R7
-#define prime2	R8
-#define prime3	R9
-#define prime4	R10
-#define prime5	R11
-#define v1	R12
-#define v2	R13
-#define v3	R14
-#define v4	R15
-#define x1	R20
-#define x2	R21
-#define x3	R22
-#define x4	R23
-
-#define round(acc, x) \
-	MADD prime2, acc, x, acc \
-	ROR  $64-31, acc         \
-	MUL  prime1, acc
-
-// round0 performs the operation x = round(0, x).
-#define round0(x) \
-	MUL prime2, x \
-	ROR $64-31, x \
-	MUL prime1, x
-
-#define mergeRound(acc, x) \
-	round0(x)                     \
-	EOR  x, acc                   \
-	MADD acc, prime4, prime1, acc
-
-// blockLoop processes as many 32-byte blocks as possible,
-// updating v1, v2, v3, and v4. It assumes that n >= 32.
-#define blockLoop() \
-	LSR     $5, n, nblocks  \
-	PCALIGN $16             \
-	loop:                   \
-	LDP.P   16(p), (x1, x2) \
-	LDP.P   16(p), (x3, x4) \
-	round(v1, x1)           \
-	round(v2, x2)           \
-	round(v3, x3)           \
-	round(v4, x4)           \
-	SUB     $1, nblocks     \
-	CBNZ    nblocks, loop
-
-// func Sum64(b []byte) uint64
-TEXT ·Sum64(SB), NOSPLIT|NOFRAME, $0-32
-	LDP b_base+0(FP), (p, n)
-
-	LDP  ·primes+0(SB), (prime1, prime2)
-	LDP  ·primes+16(SB), (prime3, prime4)
-	MOVD ·primes+32(SB), prime5
-
-	CMP  $32, n
-	CSEL LT, prime5, ZR, h // if n < 32 { h = prime5 } else { h = 0 }
-	BLT  afterLoop
-
-	ADD  prime1, prime2, v1
-	MOVD prime2, v2
-	MOVD $0, v3
-	NEG  prime1, v4
-
-	blockLoop()
-
-	ROR $64-1, v1, x1
-	ROR $64-7, v2, x2
-	ADD x1, x2
-	ROR $64-12, v3, x3
-	ROR $64-18, v4, x4
-	ADD x3, x4
-	ADD x2, x4, h
-
-	mergeRound(h, v1)
-	mergeRound(h, v2)
-	mergeRound(h, v3)
-	mergeRound(h, v4)
-
-afterLoop:
-	ADD n, h
-
-	TBZ   $4, n, try8
-	LDP.P 16(p), (x1, x2)
-
-	round0(x1)
-
-	// NOTE: here and below, sequencing the EOR after the ROR (using a
-	// rotated register) is worth a small but measurable speedup for small
-	// inputs.
-	ROR  $64-27, h
-	EOR  x1 @> 64-27, h, h
-	MADD h, prime4, prime1, h
-
-	round0(x2)
-	ROR  $64-27, h
-	EOR  x2 @> 64-27, h, h
-	MADD h, prime4, prime1, h
-
-try8:
-	TBZ    $3, n, try4
-	MOVD.P 8(p), x1
-
-	round0(x1)
-	ROR  $64-27, h
-	EOR  x1 @> 64-27, h, h
-	MADD h, prime4, prime1, h
-
-try4:
-	TBZ     $2, n, try2
-	MOVWU.P 4(p), x2
-
-	MUL  prime1, x2
-	ROR  $64-23, h
-	EOR  x2 @> 64-23, h, h
-	MADD h, prime3, prime2, h
-
-try2:
-	TBZ     $1, n, try1
-	MOVHU.P 2(p), x3
-	AND     $255, x3, x1
-	LSR     $8, x3, x2
-
-	MUL prime5, x1
-	ROR $64-11, h
-	EOR x1 @> 64-11, h, h
-	MUL prime1, h
-
-	MUL prime5, x2
-	ROR $64-11, h
-	EOR x2 @> 64-11, h, h
-	MUL prime1, h
-
-try1:
-	TBZ   $0, n, finalize
-	MOVBU (p), x4
-
-	MUL prime5, x4
-	ROR $64-11, h
-	EOR x4 @> 64-11, h, h
-	MUL prime1, h
-
-finalize:
-	EOR h >> 33, h
-	MUL prime2, h
-	EOR h >> 29, h
-	MUL prime3, h
-	EOR h >> 32, h
-
-	MOVD h, ret+24(FP)
-	RET
-
-// func writeBlocks(d *Digest, b []byte) int
-TEXT ·writeBlocks(SB), NOSPLIT|NOFRAME, $0-40
-	LDP ·primes+0(SB), (prime1, prime2)
-
-	// Load state. Assume v[1-4] are stored contiguously.
-	MOVD d+0(FP), digest
-	LDP  0(digest), (v1, v2)
-	LDP  16(digest), (v3, v4)
-
-	LDP b_base+8(FP), (p, n)
-
-	blockLoop()
-
-	// Store updated state.
-	STP (v1, v2), 0(digest)
-	STP (v3, v4), 16(digest)
-
-	BIC  $31, n
-	MOVD n, ret+32(FP)
-	RET

vendor/github.com/cespare/xxhash/v2/xxhash_asm.go

@@ -1,15 +0,0 @@
-//go:build (amd64 || arm64) && !appengine && gc && !purego
-// +build amd64 arm64
-// +build !appengine
-// +build gc
-// +build !purego
-
-package xxhash
-
-// Sum64 computes the 64-bit xxHash digest of b with a zero seed.
-//
-//go:noescape
-func Sum64(b []byte) uint64
-
-//go:noescape
-func writeBlocks(d *Digest, b []byte) int

vendor/github.com/cespare/xxhash/v2/xxhash_other.go

@@ -1,76 +0,0 @@
-//go:build (!amd64 && !arm64) || appengine || !gc || purego
-// +build !amd64,!arm64 appengine !gc purego
-
-package xxhash
-
-// Sum64 computes the 64-bit xxHash digest of b with a zero seed.
-func Sum64(b []byte) uint64 {
-	// A simpler version would be
-	//   d := New()
-	//   d.Write(b)
-	//   return d.Sum64()
-	// but this is faster, particularly for small inputs.
-
-	n := len(b)
-	var h uint64
-
-	if n >= 32 {
-		v1 := primes[0] + prime2
-		v2 := prime2
-		v3 := uint64(0)
-		v4 := -primes[0]
-		for len(b) >= 32 {
-			v1 = round(v1, u64(b[0:8:len(b)]))
-			v2 = round(v2, u64(b[8:16:len(b)]))
-			v3 = round(v3, u64(b[16:24:len(b)]))
-			v4 = round(v4, u64(b[24:32:len(b)]))
-			b = b[32:len(b):len(b)]
-		}
-		h = rol1(v1) + rol7(v2) + rol12(v3) + rol18(v4)
-		h = mergeRound(h, v1)
-		h = mergeRound(h, v2)
-		h = mergeRound(h, v3)
-		h = mergeRound(h, v4)
-	} else {
-		h = prime5
-	}
-
-	h += uint64(n)
-
-	for ; len(b) >= 8; b = b[8:] {
-		k1 := round(0, u64(b[:8]))
-		h ^= k1
-		h = rol27(h)*prime1 + prime4
-	}
-	if len(b) >= 4 {
-		h ^= uint64(u32(b[:4])) * prime1
-		h = rol23(h)*prime2 + prime3
-		b = b[4:]
-	}
-	for ; len(b) > 0; b = b[1:] {
-		h ^= uint64(b[0]) * prime5
-		h = rol11(h) * prime1
-	}
-
-	h ^= h >> 33
-	h *= prime2
-	h ^= h >> 29
-	h *= prime3
-	h ^= h >> 32
-
-	return h
-}
-
-func writeBlocks(d *Digest, b []byte) int {
-	v1, v2, v3, v4 := d.v1, d.v2, d.v3, d.v4
-	n := len(b)
-	for len(b) >= 32 {
-		v1 = round(v1, u64(b[0:8:len(b)]))
-		v2 = round(v2, u64(b[8:16:len(b)]))
-		v3 = round(v3, u64(b[16:24:len(b)]))
-		v4 = round(v4, u64(b[24:32:len(b)]))
-		b = b[32:len(b):len(b)]
-	}
-	d.v1, d.v2, d.v3, d.v4 = v1, v2, v3, v4
-	return n - len(b)
-}

vendor/github.com/cespare/xxhash/v2/xxhash_safe.go

@@ -1,16 +0,0 @@
-//go:build appengine
-// +build appengine
-
-// This file contains the safe implementations of otherwise unsafe-using code.
-
-package xxhash
-
-// Sum64String computes the 64-bit xxHash digest of s with a zero seed.
-func Sum64String(s string) uint64 {
-	return Sum64([]byte(s))
-}
-
-// WriteString adds more data to d. It always returns len(s), nil.
-func (d *Digest) WriteString(s string) (n int, err error) {
-	return d.Write([]byte(s))
-}

vendor/github.com/cespare/xxhash/v2/xxhash_unsafe.go

@@ -1,58 +0,0 @@
-//go:build !appengine
-// +build !appengine
-
-// This file encapsulates usage of unsafe.
-// xxhash_safe.go contains the safe implementations.
-
-package xxhash
-
-import (
-	"unsafe"
-)
-
-// In the future it's possible that compiler optimizations will make these
-// XxxString functions unnecessary by realizing that calls such as
-// Sum64([]byte(s)) don't need to copy s. See https://go.dev/issue/2205.
-// If that happens, even if we keep these functions they can be replaced with
-// the trivial safe code.
-
-// NOTE: The usual way of doing an unsafe string-to-[]byte conversion is:
-//
-//   var b []byte
-//   bh := (*reflect.SliceHeader)(unsafe.Pointer(&b))
-//   bh.Data = (*reflect.StringHeader)(unsafe.Pointer(&s)).Data
-//   bh.Len = len(s)
-//   bh.Cap = len(s)
-//
-// Unfortunately, as of Go 1.15.3 the inliner's cost model assigns a high enough
-// weight to this sequence of expressions that any function that uses it will
-// not be inlined. Instead, the functions below use a different unsafe
-// conversion designed to minimize the inliner weight and allow both to be
-// inlined. There is also a test (TestInlining) which verifies that these are
-// inlined.
-//
-// See https://github.com/golang/go/issues/42739 for discussion.
-
-// Sum64String computes the 64-bit xxHash digest of s with a zero seed.
-// It may be faster than Sum64([]byte(s)) by avoiding a copy.
-func Sum64String(s string) uint64 {
-	b := *(*[]byte)(unsafe.Pointer(&sliceHeader{s, len(s)}))
-	return Sum64(b)
-}
-
-// WriteString adds more data to d. It always returns len(s), nil.
-// It may be faster than Write([]byte(s)) by avoiding a copy.
-func (d *Digest) WriteString(s string) (n int, err error) {
-	d.Write(*(*[]byte)(unsafe.Pointer(&sliceHeader{s, len(s)})))
-	// d.Write always returns len(s), nil.
-	// Ignoring the return output and returning these fixed values buys a
-	// savings of 6 in the inliner's cost model.
-	return len(s), nil
-}
-
-// sliceHeader is similar to reflect.SliceHeader, but it assumes that the layout
-// of the first two words is the same as the layout of a string.
-type sliceHeader struct {
-	s   string
-	cap int
-}

vendor/github.com/davecgh/go-spew/LICENSE

@@ -1,15 +0,0 @@
-ISC License
-
-Copyright (c) 2012-2016 Dave Collins <dave@davec.name>
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

vendor/github.com/davecgh/go-spew/spew/bypass.go

@@ -1,145 +0,0 @@
-// Copyright (c) 2015-2016 Dave Collins <dave@davec.name>
-//
-// Permission to use, copy, modify, and distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
-// NOTE: Due to the following build constraints, this file will only be compiled
-// when the code is not running on Google App Engine, compiled by GopherJS, and
-// "-tags safe" is not added to the go build command line.  The "disableunsafe"
-// tag is deprecated and thus should not be used.
-// Go versions prior to 1.4 are disabled because they use a different layout
-// for interfaces which make the implementation of unsafeReflectValue more complex.
-// +build !js,!appengine,!safe,!disableunsafe,go1.4
-
-package spew
-
-import (
-	"reflect"
-	"unsafe"
-)
-
-const (
-	// UnsafeDisabled is a build-time constant which specifies whether or
-	// not access to the unsafe package is available.
-	UnsafeDisabled = false
-
-	// ptrSize is the size of a pointer on the current arch.
-	ptrSize = unsafe.Sizeof((*byte)(nil))
-)
-
-type flag uintptr
-
-var (
-	// flagRO indicates whether the value field of a reflect.Value
-	// is read-only.
-	flagRO flag
-
-	// flagAddr indicates whether the address of the reflect.Value's
-	// value may be taken.
-	flagAddr flag
-)
-
-// flagKindMask holds the bits that make up the kind
-// part of the flags field. In all the supported versions,
-// it is in the lower 5 bits.
-const flagKindMask = flag(0x1f)
-
-// Different versions of Go have used different
-// bit layouts for the flags type. This table
-// records the known combinations.
-var okFlags = []struct {
-	ro, addr flag
-}{{
-	// From Go 1.4 to 1.5
-	ro:   1 << 5,
-	addr: 1 << 7,
-}, {
-	// Up to Go tip.
-	ro:   1<<5 | 1<<6,
-	addr: 1 << 8,
-}}
-
-var flagValOffset = func() uintptr {
-	field, ok := reflect.TypeOf(reflect.Value{}).FieldByName("flag")
-	if !ok {
-		panic("reflect.Value has no flag field")
-	}
-	return field.Offset
-}()
-
-// flagField returns a pointer to the flag field of a reflect.Value.
-func flagField(v *reflect.Value) *flag {
-	return (*flag)(unsafe.Pointer(uintptr(unsafe.Pointer(v)) + flagValOffset))
-}
-
-// unsafeReflectValue converts the passed reflect.Value into a one that bypasses
-// the typical safety restrictions preventing access to unaddressable and
-// unexported data.  It works by digging the raw pointer to the underlying
-// value out of the protected value and generating a new unprotected (unsafe)
-// reflect.Value to it.
-//
-// This allows us to check for implementations of the Stringer and error
-// interfaces to be used for pretty printing ordinarily unaddressable and
-// inaccessible values such as unexported struct fields.
-func unsafeReflectValue(v reflect.Value) reflect.Value {
-	if !v.IsValid() || (v.CanInterface() && v.CanAddr()) {
-		return v
-	}
-	flagFieldPtr := flagField(&v)
-	*flagFieldPtr &^= flagRO
-	*flagFieldPtr |= flagAddr
-	return v
-}
-
-// Sanity checks against future reflect package changes
-// to the type or semantics of the Value.flag field.
-func init() {
-	field, ok := reflect.TypeOf(reflect.Value{}).FieldByName("flag")
-	if !ok {
-		panic("reflect.Value has no flag field")
-	}
-	if field.Type.Kind() != reflect.TypeOf(flag(0)).Kind() {
-		panic("reflect.Value flag field has changed kind")
-	}
-	type t0 int
-	var t struct {
-		A t0
-		// t0 will have flagEmbedRO set.
-		t0
-		// a will have flagStickyRO set
-		a t0
-	}
-	vA := reflect.ValueOf(t).FieldByName("A")
-	va := reflect.ValueOf(t).FieldByName("a")
-	vt0 := reflect.ValueOf(t).FieldByName("t0")
-
-	// Infer flagRO from the difference between the flags
-	// for the (otherwise identical) fields in t.
-	flagPublic := *flagField(&vA)
-	flagWithRO := *flagField(&va) | *flagField(&vt0)
-	flagRO = flagPublic ^ flagWithRO
-
-	// Infer flagAddr from the difference between a value
-	// taken from a pointer and not.
-	vPtrA := reflect.ValueOf(&t).Elem().FieldByName("A")
-	flagNoPtr := *flagField(&vA)
-	flagPtr := *flagField(&vPtrA)
-	flagAddr = flagNoPtr ^ flagPtr
-
-	// Check that the inferred flags tally with one of the known versions.
-	for _, f := range okFlags {
-		if flagRO == f.ro && flagAddr == f.addr {
-			return
-		}
-	}
-	panic("reflect.Value read-only flag has changed semantics")
-}

vendor/github.com/davecgh/go-spew/spew/bypasssafe.go

@@ -1,38 +0,0 @@
-// Copyright (c) 2015-2016 Dave Collins <dave@davec.name>
-//
-// Permission to use, copy, modify, and distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
-// NOTE: Due to the following build constraints, this file will only be compiled
-// when the code is running on Google App Engine, compiled by GopherJS, or
-// "-tags safe" is added to the go build command line.  The "disableunsafe"
-// tag is deprecated and thus should not be used.
-// +build js appengine safe disableunsafe !go1.4
-
-package spew
-
-import "reflect"
-
-const (
-	// UnsafeDisabled is a build-time constant which specifies whether or
-	// not access to the unsafe package is available.
-	UnsafeDisabled = true
-)
-
-// unsafeReflectValue typically converts the passed reflect.Value into a one
-// that bypasses the typical safety restrictions preventing access to
-// unaddressable and unexported data.  However, doing this relies on access to
-// the unsafe package.  This is a stub version which simply returns the passed
-// reflect.Value when the unsafe package is not available.
-func unsafeReflectValue(v reflect.Value) reflect.Value {
-	return v
-}

vendor/github.com/davecgh/go-spew/spew/common.go

@@ -1,341 +0,0 @@
-/*
- * Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
-
-package spew
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-	"reflect"
-	"sort"
-	"strconv"
-)
-
-// Some constants in the form of bytes to avoid string overhead.  This mirrors
-// the technique used in the fmt package.
-var (
-	panicBytes            = []byte("(PANIC=")
-	plusBytes             = []byte("+")
-	iBytes                = []byte("i")
-	trueBytes             = []byte("true")
-	falseBytes            = []byte("false")
-	interfaceBytes        = []byte("(interface {})")
-	commaNewlineBytes     = []byte(",\n")
-	newlineBytes          = []byte("\n")
-	openBraceBytes        = []byte("{")
-	openBraceNewlineBytes = []byte("{\n")
-	closeBraceBytes       = []byte("}")
-	asteriskBytes         = []byte("*")
-	colonBytes            = []byte(":")
-	colonSpaceBytes       = []byte(": ")
-	openParenBytes        = []byte("(")
-	closeParenBytes       = []byte(")")
-	spaceBytes            = []byte(" ")
-	pointerChainBytes     = []byte("->")
-	nilAngleBytes         = []byte("<nil>")
-	maxNewlineBytes       = []byte("<max depth reached>\n")
-	maxShortBytes         = []byte("<max>")
-	circularBytes         = []byte("<already shown>")
-	circularShortBytes    = []byte("<shown>")
-	invalidAngleBytes     = []byte("<invalid>")
-	openBracketBytes      = []byte("[")
-	closeBracketBytes     = []byte("]")
-	percentBytes          = []byte("%")
-	precisionBytes        = []byte(".")
-	openAngleBytes        = []byte("<")
-	closeAngleBytes       = []byte(">")
-	openMapBytes          = []byte("map[")
-	closeMapBytes         = []byte("]")
-	lenEqualsBytes        = []byte("len=")
-	capEqualsBytes        = []byte("cap=")
-)
-
-// hexDigits is used to map a decimal value to a hex digit.
-var hexDigits = "0123456789abcdef"
-
-// catchPanic handles any panics that might occur during the handleMethods
-// calls.
-func catchPanic(w io.Writer, v reflect.Value) {
-	if err := recover(); err != nil {
-		w.Write(panicBytes)
-		fmt.Fprintf(w, "%v", err)
-		w.Write(closeParenBytes)
-	}
-}
-
-// handleMethods attempts to call the Error and String methods on the underlying
-// type the passed reflect.Value represents and outputes the result to Writer w.
-//
-// It handles panics in any called methods by catching and displaying the error
-// as the formatted value.
-func handleMethods(cs *ConfigState, w io.Writer, v reflect.Value) (handled bool) {
-	// We need an interface to check if the type implements the error or
-	// Stringer interface.  However, the reflect package won't give us an
-	// interface on certain things like unexported struct fields in order
-	// to enforce visibility rules.  We use unsafe, when it's available,
-	// to bypass these restrictions since this package does not mutate the
-	// values.
-	if !v.CanInterface() {
-		if UnsafeDisabled {
-			return false
-		}
-
-		v = unsafeReflectValue(v)
-	}
-
-	// Choose whether or not to do error and Stringer interface lookups against
-	// the base type or a pointer to the base type depending on settings.
-	// Technically calling one of these methods with a pointer receiver can
-	// mutate the value, however, types which choose to satisify an error or
-	// Stringer interface with a pointer receiver should not be mutating their
-	// state inside these interface methods.
-	if !cs.DisablePointerMethods && !UnsafeDisabled && !v.CanAddr() {
-		v = unsafeReflectValue(v)
-	}
-	if v.CanAddr() {
-		v = v.Addr()
-	}
-
-	// Is it an error or Stringer?
-	switch iface := v.Interface().(type) {
-	case error:
-		defer catchPanic(w, v)
-		if cs.ContinueOnMethod {
-			w.Write(openParenBytes)
-			w.Write([]byte(iface.Error()))
-			w.Write(closeParenBytes)
-			w.Write(spaceBytes)
-			return false
-		}
-
-		w.Write([]byte(iface.Error()))
-		return true
-
-	case fmt.Stringer:
-		defer catchPanic(w, v)
-		if cs.ContinueOnMethod {
-			w.Write(openParenBytes)
-			w.Write([]byte(iface.String()))
-			w.Write(closeParenBytes)
-			w.Write(spaceBytes)
-			return false
-		}
-		w.Write([]byte(iface.String()))
-		return true
-	}
-	return false
-}
-
-// printBool outputs a boolean value as true or false to Writer w.
-func printBool(w io.Writer, val bool) {
-	if val {
-		w.Write(trueBytes)
-	} else {
-		w.Write(falseBytes)
-	}
-}
-
-// printInt outputs a signed integer value to Writer w.
-func printInt(w io.Writer, val int64, base int) {
-	w.Write([]byte(strconv.FormatInt(val, base)))
-}
-
-// printUint outputs an unsigned integer value to Writer w.
-func printUint(w io.Writer, val uint64, base int) {
-	w.Write([]byte(strconv.FormatUint(val, base)))
-}
-
-// printFloat outputs a floating point value using the specified precision,
-// which is expected to be 32 or 64bit, to Writer w.
-func printFloat(w io.Writer, val float64, precision int) {
-	w.Write([]byte(strconv.FormatFloat(val, 'g', -1, precision)))
-}
-
-// printComplex outputs a complex value using the specified float precision
-// for the real and imaginary parts to Writer w.
-func printComplex(w io.Writer, c complex128, floatPrecision int) {
-	r := real(c)
-	w.Write(openParenBytes)
-	w.Write([]byte(strconv.FormatFloat(r, 'g', -1, floatPrecision)))
-	i := imag(c)
-	if i >= 0 {
-		w.Write(plusBytes)
-	}
-	w.Write([]byte(strconv.FormatFloat(i, 'g', -1, floatPrecision)))
-	w.Write(iBytes)
-	w.Write(closeParenBytes)
-}
-
-// printHexPtr outputs a uintptr formatted as hexadecimal with a leading '0x'
-// prefix to Writer w.
-func printHexPtr(w io.Writer, p uintptr) {
-	// Null pointer.
-	num := uint64(p)
-	if num == 0 {
-		w.Write(nilAngleBytes)
-		return
-	}
-
-	// Max uint64 is 16 bytes in hex + 2 bytes for '0x' prefix
-	buf := make([]byte, 18)
-
-	// It's simpler to construct the hex string right to left.
-	base := uint64(16)
-	i := len(buf) - 1
-	for num >= base {
-		buf[i] = hexDigits[num%base]
-		num /= base
-		i--
-	}
-	buf[i] = hexDigits[num]
-
-	// Add '0x' prefix.
-	i--
-	buf[i] = 'x'
-	i--
-	buf[i] = '0'
-
-	// Strip unused leading bytes.
-	buf = buf[i:]
-	w.Write(buf)
-}
-
-// valuesSorter implements sort.Interface to allow a slice of reflect.Value
-// elements to be sorted.
-type valuesSorter struct {
-	values  []reflect.Value
-	strings []string // either nil or same len and values
-	cs      *ConfigState
-}
-
-// newValuesSorter initializes a valuesSorter instance, which holds a set of
-// surrogate keys on which the data should be sorted.  It uses flags in
-// ConfigState to decide if and how to populate those surrogate keys.
-func newValuesSorter(values []reflect.Value, cs *ConfigState) sort.Interface {
-	vs := &valuesSorter{values: values, cs: cs}
-	if canSortSimply(vs.values[0].Kind()) {
-		return vs
-	}
-	if !cs.DisableMethods {
-		vs.strings = make([]string, len(values))
-		for i := range vs.values {
-			b := bytes.Buffer{}
-			if !handleMethods(cs, &b, vs.values[i]) {
-				vs.strings = nil
-				break
-			}
-			vs.strings[i] = b.String()
-		}
-	}
-	if vs.strings == nil && cs.SpewKeys {
-		vs.strings = make([]string, len(values))
-		for i := range vs.values {
-			vs.strings[i] = Sprintf("%#v", vs.values[i].Interface())
-		}
-	}
-	return vs
-}
-
-// canSortSimply tests whether a reflect.Kind is a primitive that can be sorted
-// directly, or whether it should be considered for sorting by surrogate keys
-// (if the ConfigState allows it).
-func canSortSimply(kind reflect.Kind) bool {
-	// This switch parallels valueSortLess, except for the default case.
-	switch kind {
-	case reflect.Bool:
-		return true
-	case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
-		return true
-	case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
-		return true
-	case reflect.Float32, reflect.Float64:
-		return true
-	case reflect.String:
-		return true
-	case reflect.Uintptr:
-		return true
-	case reflect.Array:
-		return true
-	}
-	return false
-}
-
-// Len returns the number of values in the slice.  It is part of the
-// sort.Interface implementation.
-func (s *valuesSorter) Len() int {
-	return len(s.values)
-}
-
-// Swap swaps the values at the passed indices.  It is part of the
-// sort.Interface implementation.
-func (s *valuesSorter) Swap(i, j int) {
-	s.values[i], s.values[j] = s.values[j], s.values[i]
-	if s.strings != nil {
-		s.strings[i], s.strings[j] = s.strings[j], s.strings[i]
-	}
-}
-
-// valueSortLess returns whether the first value should sort before the second
-// value.  It is used by valueSorter.Less as part of the sort.Interface
-// implementation.
-func valueSortLess(a, b reflect.Value) bool {
-	switch a.Kind() {
-	case reflect.Bool:
-		return !a.Bool() && b.Bool()
-	case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
-		return a.Int() < b.Int()
-	case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
-		return a.Uint() < b.Uint()
-	case reflect.Float32, reflect.Float64:
-		return a.Float() < b.Float()
-	case reflect.String:
-		return a.String() < b.String()
-	case reflect.Uintptr:
-		return a.Uint() < b.Uint()
-	case reflect.Array:
-		// Compare the contents of both arrays.
-		l := a.Len()
-		for i := 0; i < l; i++ {
-			av := a.Index(i)
-			bv := b.Index(i)
-			if av.Interface() == bv.Interface() {
-				continue
-			}
-			return valueSortLess(av, bv)
-		}
-	}
-	return a.String() < b.String()
-}
-
-// Less returns whether the value at index i should sort before the
-// value at index j.  It is part of the sort.Interface implementation.
-func (s *valuesSorter) Less(i, j int) bool {
-	if s.strings == nil {
-		return valueSortLess(s.values[i], s.values[j])
-	}
-	return s.strings[i] < s.strings[j]
-}
-
-// sortValues is a sort function that handles both native types and any type that
-// can be converted to error or Stringer.  Other inputs are sorted according to
-// their Value.String() value to ensure display stability.
-func sortValues(values []reflect.Value, cs *ConfigState) {
-	if len(values) == 0 {
-		return
-	}
-	sort.Sort(newValuesSorter(values, cs))
-}

vendor/github.com/davecgh/go-spew/spew/config.go

@@ -1,306 +0,0 @@
-/*
- * Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
-
-package spew
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-	"os"
-)
-
-// ConfigState houses the configuration options used by spew to format and
-// display values.  There is a global instance, Config, that is used to control
-// all top-level Formatter and Dump functionality.  Each ConfigState instance
-// provides methods equivalent to the top-level functions.
-//
-// The zero value for ConfigState provides no indentation.  You would typically
-// want to set it to a space or a tab.
-//
-// Alternatively, you can use NewDefaultConfig to get a ConfigState instance
-// with default settings.  See the documentation of NewDefaultConfig for default
-// values.
-type ConfigState struct {
-	// Indent specifies the string to use for each indentation level.  The
-	// global config instance that all top-level functions use set this to a
-	// single space by default.  If you would like more indentation, you might
-	// set this to a tab with "\t" or perhaps two spaces with "  ".
-	Indent string
-
-	// MaxDepth controls the maximum number of levels to descend into nested
-	// data structures.  The default, 0, means there is no limit.
-	//
-	// NOTE: Circular data structures are properly detected, so it is not
-	// necessary to set this value unless you specifically want to limit deeply
-	// nested data structures.
-	MaxDepth int
-
-	// DisableMethods specifies whether or not error and Stringer interfaces are
-	// invoked for types that implement them.
-	DisableMethods bool
-
-	// DisablePointerMethods specifies whether or not to check for and invoke
-	// error and Stringer interfaces on types which only accept a pointer
-	// receiver when the current type is not a pointer.
-	//
-	// NOTE: This might be an unsafe action since calling one of these methods
-	// with a pointer receiver could technically mutate the value, however,
-	// in practice, types which choose to satisify an error or Stringer
-	// interface with a pointer receiver should not be mutating their state
-	// inside these interface methods.  As a result, this option relies on
-	// access to the unsafe package, so it will not have any effect when
-	// running in environments without access to the unsafe package such as
-	// Google App Engine or with the "safe" build tag specified.
-	DisablePointerMethods bool
-
-	// DisablePointerAddresses specifies whether to disable the printing of
-	// pointer addresses. This is useful when diffing data structures in tests.
-	DisablePointerAddresses bool
-
-	// DisableCapacities specifies whether to disable the printing of capacities
-	// for arrays, slices, maps and channels. This is useful when diffing
-	// data structures in tests.
-	DisableCapacities bool
-
-	// ContinueOnMethod specifies whether or not recursion should continue once
-	// a custom error or Stringer interface is invoked.  The default, false,
-	// means it will print the results of invoking the custom error or Stringer
-	// interface and return immediately instead of continuing to recurse into
-	// the internals of the data type.
-	//
-	// NOTE: This flag does not have any effect if method invocation is disabled
-	// via the DisableMethods or DisablePointerMethods options.
-	ContinueOnMethod bool
-
-	// SortKeys specifies map keys should be sorted before being printed. Use
-	// this to have a more deterministic, diffable output.  Note that only
-	// native types (bool, int, uint, floats, uintptr and string) and types
-	// that support the error or Stringer interfaces (if methods are
-	// enabled) are supported, with other types sorted according to the
-	// reflect.Value.String() output which guarantees display stability.
-	SortKeys bool
-
-	// SpewKeys specifies that, as a last resort attempt, map keys should
-	// be spewed to strings and sorted by those strings.  This is only
-	// considered if SortKeys is true.
-	SpewKeys bool
-}
-
-// Config is the active configuration of the top-level functions.
-// The configuration can be changed by modifying the contents of spew.Config.
-var Config = ConfigState{Indent: " "}
-
-// Errorf is a wrapper for fmt.Errorf that treats each argument as if it were
-// passed with a Formatter interface returned by c.NewFormatter.  It returns
-// the formatted string as a value that satisfies error.  See NewFormatter
-// for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Errorf(format, c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Errorf(format string, a ...interface{}) (err error) {
-	return fmt.Errorf(format, c.convertArgs(a)...)
-}
-
-// Fprint is a wrapper for fmt.Fprint that treats each argument as if it were
-// passed with a Formatter interface returned by c.NewFormatter.  It returns
-// the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Fprint(w, c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Fprint(w io.Writer, a ...interface{}) (n int, err error) {
-	return fmt.Fprint(w, c.convertArgs(a)...)
-}
-
-// Fprintf is a wrapper for fmt.Fprintf that treats each argument as if it were
-// passed with a Formatter interface returned by c.NewFormatter.  It returns
-// the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Fprintf(w, format, c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) {
-	return fmt.Fprintf(w, format, c.convertArgs(a)...)
-}
-
-// Fprintln is a wrapper for fmt.Fprintln that treats each argument as if it
-// passed with a Formatter interface returned by c.NewFormatter.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Fprintln(w, c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Fprintln(w io.Writer, a ...interface{}) (n int, err error) {
-	return fmt.Fprintln(w, c.convertArgs(a)...)
-}
-
-// Print is a wrapper for fmt.Print that treats each argument as if it were
-// passed with a Formatter interface returned by c.NewFormatter.  It returns
-// the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Print(c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Print(a ...interface{}) (n int, err error) {
-	return fmt.Print(c.convertArgs(a)...)
-}
-
-// Printf is a wrapper for fmt.Printf that treats each argument as if it were
-// passed with a Formatter interface returned by c.NewFormatter.  It returns
-// the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Printf(format, c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Printf(format string, a ...interface{}) (n int, err error) {
-	return fmt.Printf(format, c.convertArgs(a)...)
-}
-
-// Println is a wrapper for fmt.Println that treats each argument as if it were
-// passed with a Formatter interface returned by c.NewFormatter.  It returns
-// the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Println(c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Println(a ...interface{}) (n int, err error) {
-	return fmt.Println(c.convertArgs(a)...)
-}
-
-// Sprint is a wrapper for fmt.Sprint that treats each argument as if it were
-// passed with a Formatter interface returned by c.NewFormatter.  It returns
-// the resulting string.  See NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Sprint(c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Sprint(a ...interface{}) string {
-	return fmt.Sprint(c.convertArgs(a)...)
-}
-
-// Sprintf is a wrapper for fmt.Sprintf that treats each argument as if it were
-// passed with a Formatter interface returned by c.NewFormatter.  It returns
-// the resulting string.  See NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Sprintf(format, c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Sprintf(format string, a ...interface{}) string {
-	return fmt.Sprintf(format, c.convertArgs(a)...)
-}
-
-// Sprintln is a wrapper for fmt.Sprintln that treats each argument as if it
-// were passed with a Formatter interface returned by c.NewFormatter.  It
-// returns the resulting string.  See NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Sprintln(c.NewFormatter(a), c.NewFormatter(b))
-func (c *ConfigState) Sprintln(a ...interface{}) string {
-	return fmt.Sprintln(c.convertArgs(a)...)
-}
-
-/*
-NewFormatter returns a custom formatter that satisfies the fmt.Formatter
-interface.  As a result, it integrates cleanly with standard fmt package
-printing functions.  The formatter is useful for inline printing of smaller data
-types similar to the standard %v format specifier.
-
-The custom formatter only responds to the %v (most compact), %+v (adds pointer
-addresses), %#v (adds types), and %#+v (adds types and pointer addresses) verb
-combinations.  Any other verbs such as %x and %q will be sent to the the
-standard fmt package for formatting.  In addition, the custom formatter ignores
-the width and precision arguments (however they will still work on the format
-specifiers not handled by the custom formatter).
-
-Typically this function shouldn't be called directly.  It is much easier to make
-use of the custom formatter by calling one of the convenience functions such as
-c.Printf, c.Println, or c.Printf.
-*/
-func (c *ConfigState) NewFormatter(v interface{}) fmt.Formatter {
-	return newFormatter(c, v)
-}
-
-// Fdump formats and displays the passed arguments to io.Writer w.  It formats
-// exactly the same as Dump.
-func (c *ConfigState) Fdump(w io.Writer, a ...interface{}) {
-	fdump(c, w, a...)
-}
-
-/*
-Dump displays the passed parameters to standard out with newlines, customizable
-indentation, and additional debug information such as complete types and all
-pointer addresses used to indirect to the final value.  It provides the
-following features over the built-in printing facilities provided by the fmt
-package:
-
-	* Pointers are dereferenced and followed
-	* Circular data structures are detected and handled properly
-	* Custom Stringer/error interfaces are optionally invoked, including
-	  on unexported types
-	* Custom types which only implement the Stringer/error interfaces via
-	  a pointer receiver are optionally invoked when passing non-pointer
-	  variables
-	* Byte arrays and slices are dumped like the hexdump -C command which
-	  includes offsets, byte values in hex, and ASCII output
-
-The configuration options are controlled by modifying the public members
-of c.  See ConfigState for options documentation.
-
-See Fdump if you would prefer dumping to an arbitrary io.Writer or Sdump to
-get the formatted result as a string.
-*/
-func (c *ConfigState) Dump(a ...interface{}) {
-	fdump(c, os.Stdout, a...)
-}
-
-// Sdump returns a string with the passed arguments formatted exactly the same
-// as Dump.
-func (c *ConfigState) Sdump(a ...interface{}) string {
-	var buf bytes.Buffer
-	fdump(c, &buf, a...)
-	return buf.String()
-}
-
-// convertArgs accepts a slice of arguments and returns a slice of the same
-// length with each argument converted to a spew Formatter interface using
-// the ConfigState associated with s.
-func (c *ConfigState) convertArgs(args []interface{}) (formatters []interface{}) {
-	formatters = make([]interface{}, len(args))
-	for index, arg := range args {
-		formatters[index] = newFormatter(c, arg)
-	}
-	return formatters
-}
-
-// NewDefaultConfig returns a ConfigState with the following default settings.
-//
-// 	Indent: " "
-// 	MaxDepth: 0
-// 	DisableMethods: false
-// 	DisablePointerMethods: false
-// 	ContinueOnMethod: false
-// 	SortKeys: false
-func NewDefaultConfig() *ConfigState {
-	return &ConfigState{Indent: " "}
-}

vendor/github.com/davecgh/go-spew/spew/doc.go

@@ -1,211 +0,0 @@
-/*
- * Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
-
-/*
-Package spew implements a deep pretty printer for Go data structures to aid in
-debugging.
-
-A quick overview of the additional features spew provides over the built-in
-printing facilities for Go data types are as follows:
-
-	* Pointers are dereferenced and followed
-	* Circular data structures are detected and handled properly
-	* Custom Stringer/error interfaces are optionally invoked, including
-	  on unexported types
-	* Custom types which only implement the Stringer/error interfaces via
-	  a pointer receiver are optionally invoked when passing non-pointer
-	  variables
-	* Byte arrays and slices are dumped like the hexdump -C command which
-	  includes offsets, byte values in hex, and ASCII output (only when using
-	  Dump style)
-
-There are two different approaches spew allows for dumping Go data structures:
-
-	* Dump style which prints with newlines, customizable indentation,
-	  and additional debug information such as types and all pointer addresses
-	  used to indirect to the final value
-	* A custom Formatter interface that integrates cleanly with the standard fmt
-	  package and replaces %v, %+v, %#v, and %#+v to provide inline printing
-	  similar to the default %v while providing the additional functionality
-	  outlined above and passing unsupported format verbs such as %x and %q
-	  along to fmt
-
-Quick Start
-
-This section demonstrates how to quickly get started with spew.  See the
-sections below for further details on formatting and configuration options.
-
-To dump a variable with full newlines, indentation, type, and pointer
-information use Dump, Fdump, or Sdump:
-	spew.Dump(myVar1, myVar2, ...)
-	spew.Fdump(someWriter, myVar1, myVar2, ...)
-	str := spew.Sdump(myVar1, myVar2, ...)
-
-Alternatively, if you would prefer to use format strings with a compacted inline
-printing style, use the convenience wrappers Printf, Fprintf, etc with
-%v (most compact), %+v (adds pointer addresses), %#v (adds types), or
-%#+v (adds types and pointer addresses):
-	spew.Printf("myVar1: %v -- myVar2: %+v", myVar1, myVar2)
-	spew.Printf("myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
-	spew.Fprintf(someWriter, "myVar1: %v -- myVar2: %+v", myVar1, myVar2)
-	spew.Fprintf(someWriter, "myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
-
-Configuration Options
-
-Configuration of spew is handled by fields in the ConfigState type.  For
-convenience, all of the top-level functions use a global state available
-via the spew.Config global.
-
-It is also possible to create a ConfigState instance that provides methods
-equivalent to the top-level functions.  This allows concurrent configuration
-options.  See the ConfigState documentation for more details.
-
-The following configuration options are available:
-	* Indent
-		String to use for each indentation level for Dump functions.
-		It is a single space by default.  A popular alternative is "\t".
-
-	* MaxDepth
-		Maximum number of levels to descend into nested data structures.
-		There is no limit by default.
-
-	* DisableMethods
-		Disables invocation of error and Stringer interface methods.
-		Method invocation is enabled by default.
-
-	* DisablePointerMethods
-		Disables invocation of error and Stringer interface methods on types
-		which only accept pointer receivers from non-pointer variables.
-		Pointer method invocation is enabled by default.
-
-	* DisablePointerAddresses
-		DisablePointerAddresses specifies whether to disable the printing of
-		pointer addresses. This is useful when diffing data structures in tests.
-
-	* DisableCapacities
-		DisableCapacities specifies whether to disable the printing of
-		capacities for arrays, slices, maps and channels. This is useful when
-		diffing data structures in tests.
-
-	* ContinueOnMethod
-		Enables recursion into types after invoking error and Stringer interface
-		methods. Recursion after method invocation is disabled by default.
-
-	* SortKeys
-		Specifies map keys should be sorted before being printed. Use
-		this to have a more deterministic, diffable output.  Note that
-		only native types (bool, int, uint, floats, uintptr and string)
-		and types which implement error or Stringer interfaces are
-		supported with other types sorted according to the
-		reflect.Value.String() output which guarantees display
-		stability.  Natural map order is used by default.
-
-	* SpewKeys
-		Specifies that, as a last resort attempt, map keys should be
-		spewed to strings and sorted by those strings.  This is only
-		considered if SortKeys is true.
-
-Dump Usage
-
-Simply call spew.Dump with a list of variables you want to dump:
-
-	spew.Dump(myVar1, myVar2, ...)
-
-You may also call spew.Fdump if you would prefer to output to an arbitrary
-io.Writer.  For example, to dump to standard error:
-
-	spew.Fdump(os.Stderr, myVar1, myVar2, ...)
-
-A third option is to call spew.Sdump to get the formatted output as a string:
-
-	str := spew.Sdump(myVar1, myVar2, ...)
-
-Sample Dump Output
-
-See the Dump example for details on the setup of the types and variables being
-shown here.
-
-	(main.Foo) {
-	 unexportedField: (*main.Bar)(0xf84002e210)({
-	  flag: (main.Flag) flagTwo,
-	  data: (uintptr) <nil>
-	 }),
-	 ExportedField: (map[interface {}]interface {}) (len=1) {
-	  (string) (len=3) "one": (bool) true
-	 }
-	}
-
-Byte (and uint8) arrays and slices are displayed uniquely like the hexdump -C
-command as shown.
-	([]uint8) (len=32 cap=32) {
-	 00000000  11 12 13 14 15 16 17 18  19 1a 1b 1c 1d 1e 1f 20  |............... |
-	 00000010  21 22 23 24 25 26 27 28  29 2a 2b 2c 2d 2e 2f 30  |!"#$%&'()*+,-./0|
-	 00000020  31 32                                             |12|
-	}
-
-Custom Formatter
-
-Spew provides a custom formatter that implements the fmt.Formatter interface
-so that it integrates cleanly with standard fmt package printing functions. The
-formatter is useful for inline printing of smaller data types similar to the
-standard %v format specifier.
-
-The custom formatter only responds to the %v (most compact), %+v (adds pointer
-addresses), %#v (adds types), or %#+v (adds types and pointer addresses) verb
-combinations.  Any other verbs such as %x and %q will be sent to the the
-standard fmt package for formatting.  In addition, the custom formatter ignores
-the width and precision arguments (however they will still work on the format
-specifiers not handled by the custom formatter).
-
-Custom Formatter Usage
-
-The simplest way to make use of the spew custom formatter is to call one of the
-convenience functions such as spew.Printf, spew.Println, or spew.Printf.  The
-functions have syntax you are most likely already familiar with:
-
-	spew.Printf("myVar1: %v -- myVar2: %+v", myVar1, myVar2)
-	spew.Printf("myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
-	spew.Println(myVar, myVar2)
-	spew.Fprintf(os.Stderr, "myVar1: %v -- myVar2: %+v", myVar1, myVar2)
-	spew.Fprintf(os.Stderr, "myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
-
-See the Index for the full list convenience functions.
-
-Sample Formatter Output
-
-Double pointer to a uint8:
-	  %v: <**>5
-	 %+v: <**>(0xf8400420d0->0xf8400420c8)5
-	 %#v: (**uint8)5
-	%#+v: (**uint8)(0xf8400420d0->0xf8400420c8)5
-
-Pointer to circular struct with a uint8 field and a pointer to itself:
-	  %v: <*>{1 <*><shown>}
-	 %+v: <*>(0xf84003e260){ui8:1 c:<*>(0xf84003e260)<shown>}
-	 %#v: (*main.circular){ui8:(uint8)1 c:(*main.circular)<shown>}
-	%#+v: (*main.circular)(0xf84003e260){ui8:(uint8)1 c:(*main.circular)(0xf84003e260)<shown>}
-
-See the Printf example for details on the setup of variables being shown
-here.
-
-Errors
-
-Since it is possible for custom Stringer/error interfaces to panic, spew
-detects them and handles them internally by printing the panic information
-inline with the output.  Since spew is intended to provide deep pretty printing
-capabilities on structures, it intentionally does not return any errors.
-*/
-package spew

vendor/github.com/davecgh/go-spew/spew/dump.go

@@ -1,509 +0,0 @@
-/*
- * Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
-
-package spew
-
-import (
-	"bytes"
-	"encoding/hex"
-	"fmt"
-	"io"
-	"os"
-	"reflect"
-	"regexp"
-	"strconv"
-	"strings"
-)
-
-var (
-	// uint8Type is a reflect.Type representing a uint8.  It is used to
-	// convert cgo types to uint8 slices for hexdumping.
-	uint8Type = reflect.TypeOf(uint8(0))
-
-	// cCharRE is a regular expression that matches a cgo char.
-	// It is used to detect character arrays to hexdump them.
-	cCharRE = regexp.MustCompile(`^.*\._Ctype_char$`)
-
-	// cUnsignedCharRE is a regular expression that matches a cgo unsigned
-	// char.  It is used to detect unsigned character arrays to hexdump
-	// them.
-	cUnsignedCharRE = regexp.MustCompile(`^.*\._Ctype_unsignedchar$`)
-
-	// cUint8tCharRE is a regular expression that matches a cgo uint8_t.
-	// It is used to detect uint8_t arrays to hexdump them.
-	cUint8tCharRE = regexp.MustCompile(`^.*\._Ctype_uint8_t$`)
-)
-
-// dumpState contains information about the state of a dump operation.
-type dumpState struct {
-	w                io.Writer
-	depth            int
-	pointers         map[uintptr]int
-	ignoreNextType   bool
-	ignoreNextIndent bool
-	cs               *ConfigState
-}
-
-// indent performs indentation according to the depth level and cs.Indent
-// option.
-func (d *dumpState) indent() {
-	if d.ignoreNextIndent {
-		d.ignoreNextIndent = false
-		return
-	}
-	d.w.Write(bytes.Repeat([]byte(d.cs.Indent), d.depth))
-}
-
-// unpackValue returns values inside of non-nil interfaces when possible.
-// This is useful for data types like structs, arrays, slices, and maps which
-// can contain varying types packed inside an interface.
-func (d *dumpState) unpackValue(v reflect.Value) reflect.Value {
-	if v.Kind() == reflect.Interface && !v.IsNil() {
-		v = v.Elem()
-	}
-	return v
-}
-
-// dumpPtr handles formatting of pointers by indirecting them as necessary.
-func (d *dumpState) dumpPtr(v reflect.Value) {
-	// Remove pointers at or below the current depth from map used to detect
-	// circular refs.
-	for k, depth := range d.pointers {
-		if depth >= d.depth {
-			delete(d.pointers, k)
-		}
-	}
-
-	// Keep list of all dereferenced pointers to show later.
-	pointerChain := make([]uintptr, 0)
-
-	// Figure out how many levels of indirection there are by dereferencing
-	// pointers and unpacking interfaces down the chain while detecting circular
-	// references.
-	nilFound := false
-	cycleFound := false
-	indirects := 0
-	ve := v
-	for ve.Kind() == reflect.Ptr {
-		if ve.IsNil() {
-			nilFound = true
-			break
-		}
-		indirects++
-		addr := ve.Pointer()
-		pointerChain = append(pointerChain, addr)
-		if pd, ok := d.pointers[addr]; ok && pd < d.depth {
-			cycleFound = true
-			indirects--
-			break
-		}
-		d.pointers[addr] = d.depth
-
-		ve = ve.Elem()
-		if ve.Kind() == reflect.Interface {
-			if ve.IsNil() {
-				nilFound = true
-				break
-			}
-			ve = ve.Elem()
-		}
-	}
-
-	// Display type information.
-	d.w.Write(openParenBytes)
-	d.w.Write(bytes.Repeat(asteriskBytes, indirects))
-	d.w.Write([]byte(ve.Type().String()))
-	d.w.Write(closeParenBytes)
-
-	// Display pointer information.
-	if !d.cs.DisablePointerAddresses && len(pointerChain) > 0 {
-		d.w.Write(openParenBytes)
-		for i, addr := range pointerChain {
-			if i > 0 {
-				d.w.Write(pointerChainBytes)
-			}
-			printHexPtr(d.w, addr)
-		}
-		d.w.Write(closeParenBytes)
-	}
-
-	// Display dereferenced value.
-	d.w.Write(openParenBytes)
-	switch {
-	case nilFound:
-		d.w.Write(nilAngleBytes)
-
-	case cycleFound:
-		d.w.Write(circularBytes)
-
-	default:
-		d.ignoreNextType = true
-		d.dump(ve)
-	}
-	d.w.Write(closeParenBytes)
-}
-
-// dumpSlice handles formatting of arrays and slices.  Byte (uint8 under
-// reflection) arrays and slices are dumped in hexdump -C fashion.
-func (d *dumpState) dumpSlice(v reflect.Value) {
-	// Determine whether this type should be hex dumped or not.  Also,
-	// for types which should be hexdumped, try to use the underlying data
-	// first, then fall back to trying to convert them to a uint8 slice.
-	var buf []uint8
-	doConvert := false
-	doHexDump := false
-	numEntries := v.Len()
-	if numEntries > 0 {
-		vt := v.Index(0).Type()
-		vts := vt.String()
-		switch {
-		// C types that need to be converted.
-		case cCharRE.MatchString(vts):
-			fallthrough
-		case cUnsignedCharRE.MatchString(vts):
-			fallthrough
-		case cUint8tCharRE.MatchString(vts):
-			doConvert = true
-
-		// Try to use existing uint8 slices and fall back to converting
-		// and copying if that fails.
-		case vt.Kind() == reflect.Uint8:
-			// We need an addressable interface to convert the type
-			// to a byte slice.  However, the reflect package won't
-			// give us an interface on certain things like
-			// unexported struct fields in order to enforce
-			// visibility rules.  We use unsafe, when available, to
-			// bypass these restrictions since this package does not
-			// mutate the values.
-			vs := v
-			if !vs.CanInterface() || !vs.CanAddr() {
-				vs = unsafeReflectValue(vs)
-			}
-			if !UnsafeDisabled {
-				vs = vs.Slice(0, numEntries)
-
-				// Use the existing uint8 slice if it can be
-				// type asserted.
-				iface := vs.Interface()
-				if slice, ok := iface.([]uint8); ok {
-					buf = slice
-					doHexDump = true
-					break
-				}
-			}
-
-			// The underlying data needs to be converted if it can't
-			// be type asserted to a uint8 slice.
-			doConvert = true
-		}
-
-		// Copy and convert the underlying type if needed.
-		if doConvert && vt.ConvertibleTo(uint8Type) {
-			// Convert and copy each element into a uint8 byte
-			// slice.
-			buf = make([]uint8, numEntries)
-			for i := 0; i < numEntries; i++ {
-				vv := v.Index(i)
-				buf[i] = uint8(vv.Convert(uint8Type).Uint())
-			}
-			doHexDump = true
-		}
-	}
-
-	// Hexdump the entire slice as needed.
-	if doHexDump {
-		indent := strings.Repeat(d.cs.Indent, d.depth)
-		str := indent + hex.Dump(buf)
-		str = strings.Replace(str, "\n", "\n"+indent, -1)
-		str = strings.TrimRight(str, d.cs.Indent)
-		d.w.Write([]byte(str))
-		return
-	}
-
-	// Recursively call dump for each item.
-	for i := 0; i < numEntries; i++ {
-		d.dump(d.unpackValue(v.Index(i)))
-		if i < (numEntries - 1) {
-			d.w.Write(commaNewlineBytes)
-		} else {
-			d.w.Write(newlineBytes)
-		}
-	}
-}
-
-// dump is the main workhorse for dumping a value.  It uses the passed reflect
-// value to figure out what kind of object we are dealing with and formats it
-// appropriately.  It is a recursive function, however circular data structures
-// are detected and handled properly.
-func (d *dumpState) dump(v reflect.Value) {
-	// Handle invalid reflect values immediately.
-	kind := v.Kind()
-	if kind == reflect.Invalid {
-		d.w.Write(invalidAngleBytes)
-		return
-	}
-
-	// Handle pointers specially.
-	if kind == reflect.Ptr {
-		d.indent()
-		d.dumpPtr(v)
-		return
-	}
-
-	// Print type information unless already handled elsewhere.
-	if !d.ignoreNextType {
-		d.indent()
-		d.w.Write(openParenBytes)
-		d.w.Write([]byte(v.Type().String()))
-		d.w.Write(closeParenBytes)
-		d.w.Write(spaceBytes)
-	}
-	d.ignoreNextType = false
-
-	// Display length and capacity if the built-in len and cap functions
-	// work with the value's kind and the len/cap itself is non-zero.
-	valueLen, valueCap := 0, 0
-	switch v.Kind() {
-	case reflect.Array, reflect.Slice, reflect.Chan:
-		valueLen, valueCap = v.Len(), v.Cap()
-	case reflect.Map, reflect.String:
-		valueLen = v.Len()
-	}
-	if valueLen != 0 || !d.cs.DisableCapacities && valueCap != 0 {
-		d.w.Write(openParenBytes)
-		if valueLen != 0 {
-			d.w.Write(lenEqualsBytes)
-			printInt(d.w, int64(valueLen), 10)
-		}
-		if !d.cs.DisableCapacities && valueCap != 0 {
-			if valueLen != 0 {
-				d.w.Write(spaceBytes)
-			}
-			d.w.Write(capEqualsBytes)
-			printInt(d.w, int64(valueCap), 10)
-		}
-		d.w.Write(closeParenBytes)
-		d.w.Write(spaceBytes)
-	}
-
-	// Call Stringer/error interfaces if they exist and the handle methods flag
-	// is enabled
-	if !d.cs.DisableMethods {
-		if (kind != reflect.Invalid) && (kind != reflect.Interface) {
-			if handled := handleMethods(d.cs, d.w, v); handled {
-				return
-			}
-		}
-	}
-
-	switch kind {
-	case reflect.Invalid:
-		// Do nothing.  We should never get here since invalid has already
-		// been handled above.
-
-	case reflect.Bool:
-		printBool(d.w, v.Bool())
-
-	case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
-		printInt(d.w, v.Int(), 10)
-
-	case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
-		printUint(d.w, v.Uint(), 10)
-
-	case reflect.Float32:
-		printFloat(d.w, v.Float(), 32)
-
-	case reflect.Float64:
-		printFloat(d.w, v.Float(), 64)
-
-	case reflect.Complex64:
-		printComplex(d.w, v.Complex(), 32)
-
-	case reflect.Complex128:
-		printComplex(d.w, v.Complex(), 64)
-
-	case reflect.Slice:
-		if v.IsNil() {
-			d.w.Write(nilAngleBytes)
-			break
-		}
-		fallthrough
-
-	case reflect.Array:
-		d.w.Write(openBraceNewlineBytes)
-		d.depth++
-		if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
-			d.indent()
-			d.w.Write(maxNewlineBytes)
-		} else {
-			d.dumpSlice(v)
-		}
-		d.depth--
-		d.indent()
-		d.w.Write(closeBraceBytes)
-
-	case reflect.String:
-		d.w.Write([]byte(strconv.Quote(v.String())))
-
-	case reflect.Interface:
-		// The only time we should get here is for nil interfaces due to
-		// unpackValue calls.
-		if v.IsNil() {
-			d.w.Write(nilAngleBytes)
-		}
-
-	case reflect.Ptr:
-		// Do nothing.  We should never get here since pointers have already
-		// been handled above.
-
-	case reflect.Map:
-		// nil maps should be indicated as different than empty maps
-		if v.IsNil() {
-			d.w.Write(nilAngleBytes)
-			break
-		}
-
-		d.w.Write(openBraceNewlineBytes)
-		d.depth++
-		if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
-			d.indent()
-			d.w.Write(maxNewlineBytes)
-		} else {
-			numEntries := v.Len()
-			keys := v.MapKeys()
-			if d.cs.SortKeys {
-				sortValues(keys, d.cs)
-			}
-			for i, key := range keys {
-				d.dump(d.unpackValue(key))
-				d.w.Write(colonSpaceBytes)
-				d.ignoreNextIndent = true
-				d.dump(d.unpackValue(v.MapIndex(key)))
-				if i < (numEntries - 1) {
-					d.w.Write(commaNewlineBytes)
-				} else {
-					d.w.Write(newlineBytes)
-				}
-			}
-		}
-		d.depth--
-		d.indent()
-		d.w.Write(closeBraceBytes)
-
-	case reflect.Struct:
-		d.w.Write(openBraceNewlineBytes)
-		d.depth++
-		if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
-			d.indent()
-			d.w.Write(maxNewlineBytes)
-		} else {
-			vt := v.Type()
-			numFields := v.NumField()
-			for i := 0; i < numFields; i++ {
-				d.indent()
-				vtf := vt.Field(i)
-				d.w.Write([]byte(vtf.Name))
-				d.w.Write(colonSpaceBytes)
-				d.ignoreNextIndent = true
-				d.dump(d.unpackValue(v.Field(i)))
-				if i < (numFields - 1) {
-					d.w.Write(commaNewlineBytes)
-				} else {
-					d.w.Write(newlineBytes)
-				}
-			}
-		}
-		d.depth--
-		d.indent()
-		d.w.Write(closeBraceBytes)
-
-	case reflect.Uintptr:
-		printHexPtr(d.w, uintptr(v.Uint()))
-
-	case reflect.UnsafePointer, reflect.Chan, reflect.Func:
-		printHexPtr(d.w, v.Pointer())
-
-	// There were not any other types at the time this code was written, but
-	// fall back to letting the default fmt package handle it in case any new
-	// types are added.
-	default:
-		if v.CanInterface() {
-			fmt.Fprintf(d.w, "%v", v.Interface())
-		} else {
-			fmt.Fprintf(d.w, "%v", v.String())
-		}
-	}
-}
-
-// fdump is a helper function to consolidate the logic from the various public
-// methods which take varying writers and config states.
-func fdump(cs *ConfigState, w io.Writer, a ...interface{}) {
-	for _, arg := range a {
-		if arg == nil {
-			w.Write(interfaceBytes)
-			w.Write(spaceBytes)
-			w.Write(nilAngleBytes)
-			w.Write(newlineBytes)
-			continue
-		}
-
-		d := dumpState{w: w, cs: cs}
-		d.pointers = make(map[uintptr]int)
-		d.dump(reflect.ValueOf(arg))
-		d.w.Write(newlineBytes)
-	}
-}
-
-// Fdump formats and displays the passed arguments to io.Writer w.  It formats
-// exactly the same as Dump.
-func Fdump(w io.Writer, a ...interface{}) {
-	fdump(&Config, w, a...)
-}
-
-// Sdump returns a string with the passed arguments formatted exactly the same
-// as Dump.
-func Sdump(a ...interface{}) string {
-	var buf bytes.Buffer
-	fdump(&Config, &buf, a...)
-	return buf.String()
-}
-
-/*
-Dump displays the passed parameters to standard out with newlines, customizable
-indentation, and additional debug information such as complete types and all
-pointer addresses used to indirect to the final value.  It provides the
-following features over the built-in printing facilities provided by the fmt
-package:
-
-	* Pointers are dereferenced and followed
-	* Circular data structures are detected and handled properly
-	* Custom Stringer/error interfaces are optionally invoked, including
-	  on unexported types
-	* Custom types which only implement the Stringer/error interfaces via
-	  a pointer receiver are optionally invoked when passing non-pointer
-	  variables
-	* Byte arrays and slices are dumped like the hexdump -C command which
-	  includes offsets, byte values in hex, and ASCII output
-
-The configuration options are controlled by an exported package global,
-spew.Config.  See ConfigState for options documentation.
-
-See Fdump if you would prefer dumping to an arbitrary io.Writer or Sdump to
-get the formatted result as a string.
-*/
-func Dump(a ...interface{}) {
-	fdump(&Config, os.Stdout, a...)
-}

vendor/github.com/davecgh/go-spew/spew/format.go

@@ -1,419 +0,0 @@
-/*
- * Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
-
-package spew
-
-import (
-	"bytes"
-	"fmt"
-	"reflect"
-	"strconv"
-	"strings"
-)
-
-// supportedFlags is a list of all the character flags supported by fmt package.
-const supportedFlags = "0-+# "
-
-// formatState implements the fmt.Formatter interface and contains information
-// about the state of a formatting operation.  The NewFormatter function can
-// be used to get a new Formatter which can be used directly as arguments
-// in standard fmt package printing calls.
-type formatState struct {
-	value          interface{}
-	fs             fmt.State
-	depth          int
-	pointers       map[uintptr]int
-	ignoreNextType bool
-	cs             *ConfigState
-}
-
-// buildDefaultFormat recreates the original format string without precision
-// and width information to pass in to fmt.Sprintf in the case of an
-// unrecognized type.  Unless new types are added to the language, this
-// function won't ever be called.
-func (f *formatState) buildDefaultFormat() (format string) {
-	buf := bytes.NewBuffer(percentBytes)
-
-	for _, flag := range supportedFlags {
-		if f.fs.Flag(int(flag)) {
-			buf.WriteRune(flag)
-		}
-	}
-
-	buf.WriteRune('v')
-
-	format = buf.String()
-	return format
-}
-
-// constructOrigFormat recreates the original format string including precision
-// and width information to pass along to the standard fmt package.  This allows
-// automatic deferral of all format strings this package doesn't support.
-func (f *formatState) constructOrigFormat(verb rune) (format string) {
-	buf := bytes.NewBuffer(percentBytes)
-
-	for _, flag := range supportedFlags {
-		if f.fs.Flag(int(flag)) {
-			buf.WriteRune(flag)
-		}
-	}
-
-	if width, ok := f.fs.Width(); ok {
-		buf.WriteString(strconv.Itoa(width))
-	}
-
-	if precision, ok := f.fs.Precision(); ok {
-		buf.Write(precisionBytes)
-		buf.WriteString(strconv.Itoa(precision))
-	}
-
-	buf.WriteRune(verb)
-
-	format = buf.String()
-	return format
-}
-
-// unpackValue returns values inside of non-nil interfaces when possible and
-// ensures that types for values which have been unpacked from an interface
-// are displayed when the show types flag is also set.
-// This is useful for data types like structs, arrays, slices, and maps which
-// can contain varying types packed inside an interface.
-func (f *formatState) unpackValue(v reflect.Value) reflect.Value {
-	if v.Kind() == reflect.Interface {
-		f.ignoreNextType = false
-		if !v.IsNil() {
-			v = v.Elem()
-		}
-	}
-	return v
-}
-
-// formatPtr handles formatting of pointers by indirecting them as necessary.
-func (f *formatState) formatPtr(v reflect.Value) {
-	// Display nil if top level pointer is nil.
-	showTypes := f.fs.Flag('#')
-	if v.IsNil() && (!showTypes || f.ignoreNextType) {
-		f.fs.Write(nilAngleBytes)
-		return
-	}
-
-	// Remove pointers at or below the current depth from map used to detect
-	// circular refs.
-	for k, depth := range f.pointers {
-		if depth >= f.depth {
-			delete(f.pointers, k)
-		}
-	}
-
-	// Keep list of all dereferenced pointers to possibly show later.
-	pointerChain := make([]uintptr, 0)
-
-	// Figure out how many levels of indirection there are by derferencing
-	// pointers and unpacking interfaces down the chain while detecting circular
-	// references.
-	nilFound := false
-	cycleFound := false
-	indirects := 0
-	ve := v
-	for ve.Kind() == reflect.Ptr {
-		if ve.IsNil() {
-			nilFound = true
-			break
-		}
-		indirects++
-		addr := ve.Pointer()
-		pointerChain = append(pointerChain, addr)
-		if pd, ok := f.pointers[addr]; ok && pd < f.depth {
-			cycleFound = true
-			indirects--
-			break
-		}
-		f.pointers[addr] = f.depth
-
-		ve = ve.Elem()
-		if ve.Kind() == reflect.Interface {
-			if ve.IsNil() {
-				nilFound = true
-				break
-			}
-			ve = ve.Elem()
-		}
-	}
-
-	// Display type or indirection level depending on flags.
-	if showTypes && !f.ignoreNextType {
-		f.fs.Write(openParenBytes)
-		f.fs.Write(bytes.Repeat(asteriskBytes, indirects))
-		f.fs.Write([]byte(ve.Type().String()))
-		f.fs.Write(closeParenBytes)
-	} else {
-		if nilFound || cycleFound {
-			indirects += strings.Count(ve.Type().String(), "*")
-		}
-		f.fs.Write(openAngleBytes)
-		f.fs.Write([]byte(strings.Repeat("*", indirects)))
-		f.fs.Write(closeAngleBytes)
-	}
-
-	// Display pointer information depending on flags.
-	if f.fs.Flag('+') && (len(pointerChain) > 0) {
-		f.fs.Write(openParenBytes)
-		for i, addr := range pointerChain {
-			if i > 0 {
-				f.fs.Write(pointerChainBytes)
-			}
-			printHexPtr(f.fs, addr)
-		}
-		f.fs.Write(closeParenBytes)
-	}
-
-	// Display dereferenced value.
-	switch {
-	case nilFound:
-		f.fs.Write(nilAngleBytes)
-
-	case cycleFound:
-		f.fs.Write(circularShortBytes)
-
-	default:
-		f.ignoreNextType = true
-		f.format(ve)
-	}
-}
-
-// format is the main workhorse for providing the Formatter interface.  It
-// uses the passed reflect value to figure out what kind of object we are
-// dealing with and formats it appropriately.  It is a recursive function,
-// however circular data structures are detected and handled properly.
-func (f *formatState) format(v reflect.Value) {
-	// Handle invalid reflect values immediately.
-	kind := v.Kind()
-	if kind == reflect.Invalid {
-		f.fs.Write(invalidAngleBytes)
-		return
-	}
-
-	// Handle pointers specially.
-	if kind == reflect.Ptr {
-		f.formatPtr(v)
-		return
-	}
-
-	// Print type information unless already handled elsewhere.
-	if !f.ignoreNextType && f.fs.Flag('#') {
-		f.fs.Write(openParenBytes)
-		f.fs.Write([]byte(v.Type().String()))
-		f.fs.Write(closeParenBytes)
-	}
-	f.ignoreNextType = false
-
-	// Call Stringer/error interfaces if they exist and the handle methods
-	// flag is enabled.
-	if !f.cs.DisableMethods {
-		if (kind != reflect.Invalid) && (kind != reflect.Interface) {
-			if handled := handleMethods(f.cs, f.fs, v); handled {
-				return
-			}
-		}
-	}
-
-	switch kind {
-	case reflect.Invalid:
-		// Do nothing.  We should never get here since invalid has already
-		// been handled above.
-
-	case reflect.Bool:
-		printBool(f.fs, v.Bool())
-
-	case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
-		printInt(f.fs, v.Int(), 10)
-
-	case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
-		printUint(f.fs, v.Uint(), 10)
-
-	case reflect.Float32:
-		printFloat(f.fs, v.Float(), 32)
-
-	case reflect.Float64:
-		printFloat(f.fs, v.Float(), 64)
-
-	case reflect.Complex64:
-		printComplex(f.fs, v.Complex(), 32)
-
-	case reflect.Complex128:
-		printComplex(f.fs, v.Complex(), 64)
-
-	case reflect.Slice:
-		if v.IsNil() {
-			f.fs.Write(nilAngleBytes)
-			break
-		}
-		fallthrough
-
-	case reflect.Array:
-		f.fs.Write(openBracketBytes)
-		f.depth++
-		if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
-			f.fs.Write(maxShortBytes)
-		} else {
-			numEntries := v.Len()
-			for i := 0; i < numEntries; i++ {
-				if i > 0 {
-					f.fs.Write(spaceBytes)
-				}
-				f.ignoreNextType = true
-				f.format(f.unpackValue(v.Index(i)))
-			}
-		}
-		f.depth--
-		f.fs.Write(closeBracketBytes)
-
-	case reflect.String:
-		f.fs.Write([]byte(v.String()))
-
-	case reflect.Interface:
-		// The only time we should get here is for nil interfaces due to
-		// unpackValue calls.
-		if v.IsNil() {
-			f.fs.Write(nilAngleBytes)
-		}
-
-	case reflect.Ptr:
-		// Do nothing.  We should never get here since pointers have already
-		// been handled above.
-
-	case reflect.Map:
-		// nil maps should be indicated as different than empty maps
-		if v.IsNil() {
-			f.fs.Write(nilAngleBytes)
-			break
-		}
-
-		f.fs.Write(openMapBytes)
-		f.depth++
-		if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
-			f.fs.Write(maxShortBytes)
-		} else {
-			keys := v.MapKeys()
-			if f.cs.SortKeys {
-				sortValues(keys, f.cs)
-			}
-			for i, key := range keys {
-				if i > 0 {
-					f.fs.Write(spaceBytes)
-				}
-				f.ignoreNextType = true
-				f.format(f.unpackValue(key))
-				f.fs.Write(colonBytes)
-				f.ignoreNextType = true
-				f.format(f.unpackValue(v.MapIndex(key)))
-			}
-		}
-		f.depth--
-		f.fs.Write(closeMapBytes)
-
-	case reflect.Struct:
-		numFields := v.NumField()
-		f.fs.Write(openBraceBytes)
-		f.depth++
-		if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
-			f.fs.Write(maxShortBytes)
-		} else {
-			vt := v.Type()
-			for i := 0; i < numFields; i++ {
-				if i > 0 {
-					f.fs.Write(spaceBytes)
-				}
-				vtf := vt.Field(i)
-				if f.fs.Flag('+') || f.fs.Flag('#') {
-					f.fs.Write([]byte(vtf.Name))
-					f.fs.Write(colonBytes)
-				}
-				f.format(f.unpackValue(v.Field(i)))
-			}
-		}
-		f.depth--
-		f.fs.Write(closeBraceBytes)
-
-	case reflect.Uintptr:
-		printHexPtr(f.fs, uintptr(v.Uint()))
-
-	case reflect.UnsafePointer, reflect.Chan, reflect.Func:
-		printHexPtr(f.fs, v.Pointer())
-
-	// There were not any other types at the time this code was written, but
-	// fall back to letting the default fmt package handle it if any get added.
-	default:
-		format := f.buildDefaultFormat()
-		if v.CanInterface() {
-			fmt.Fprintf(f.fs, format, v.Interface())
-		} else {
-			fmt.Fprintf(f.fs, format, v.String())
-		}
-	}
-}
-
-// Format satisfies the fmt.Formatter interface. See NewFormatter for usage
-// details.
-func (f *formatState) Format(fs fmt.State, verb rune) {
-	f.fs = fs
-
-	// Use standard formatting for verbs that are not v.
-	if verb != 'v' {
-		format := f.constructOrigFormat(verb)
-		fmt.Fprintf(fs, format, f.value)
-		return
-	}
-
-	if f.value == nil {
-		if fs.Flag('#') {
-			fs.Write(interfaceBytes)
-		}
-		fs.Write(nilAngleBytes)
-		return
-	}
-
-	f.format(reflect.ValueOf(f.value))
-}
-
-// newFormatter is a helper function to consolidate the logic from the various
-// public methods which take varying config states.
-func newFormatter(cs *ConfigState, v interface{}) fmt.Formatter {
-	fs := &formatState{value: v, cs: cs}
-	fs.pointers = make(map[uintptr]int)
-	return fs
-}
-
-/*
-NewFormatter returns a custom formatter that satisfies the fmt.Formatter
-interface.  As a result, it integrates cleanly with standard fmt package
-printing functions.  The formatter is useful for inline printing of smaller data
-types similar to the standard %v format specifier.
-
-The custom formatter only responds to the %v (most compact), %+v (adds pointer
-addresses), %#v (adds types), or %#+v (adds types and pointer addresses) verb
-combinations.  Any other verbs such as %x and %q will be sent to the the
-standard fmt package for formatting.  In addition, the custom formatter ignores
-the width and precision arguments (however they will still work on the format
-specifiers not handled by the custom formatter).
-
-Typically this function shouldn't be called directly.  It is much easier to make
-use of the custom formatter by calling one of the convenience functions such as
-Printf, Println, or Fprintf.
-*/
-func NewFormatter(v interface{}) fmt.Formatter {
-	return newFormatter(&Config, v)
-}

vendor/github.com/davecgh/go-spew/spew/spew.go

@@ -1,148 +0,0 @@
-/*
- * Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
-
-package spew
-
-import (
-	"fmt"
-	"io"
-)
-
-// Errorf is a wrapper for fmt.Errorf that treats each argument as if it were
-// passed with a default Formatter interface returned by NewFormatter.  It
-// returns the formatted string as a value that satisfies error.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Errorf(format, spew.NewFormatter(a), spew.NewFormatter(b))
-func Errorf(format string, a ...interface{}) (err error) {
-	return fmt.Errorf(format, convertArgs(a)...)
-}
-
-// Fprint is a wrapper for fmt.Fprint that treats each argument as if it were
-// passed with a default Formatter interface returned by NewFormatter.  It
-// returns the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Fprint(w, spew.NewFormatter(a), spew.NewFormatter(b))
-func Fprint(w io.Writer, a ...interface{}) (n int, err error) {
-	return fmt.Fprint(w, convertArgs(a)...)
-}
-
-// Fprintf is a wrapper for fmt.Fprintf that treats each argument as if it were
-// passed with a default Formatter interface returned by NewFormatter.  It
-// returns the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Fprintf(w, format, spew.NewFormatter(a), spew.NewFormatter(b))
-func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) {
-	return fmt.Fprintf(w, format, convertArgs(a)...)
-}
-
-// Fprintln is a wrapper for fmt.Fprintln that treats each argument as if it
-// passed with a default Formatter interface returned by NewFormatter.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Fprintln(w, spew.NewFormatter(a), spew.NewFormatter(b))
-func Fprintln(w io.Writer, a ...interface{}) (n int, err error) {
-	return fmt.Fprintln(w, convertArgs(a)...)
-}
-
-// Print is a wrapper for fmt.Print that treats each argument as if it were
-// passed with a default Formatter interface returned by NewFormatter.  It
-// returns the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Print(spew.NewFormatter(a), spew.NewFormatter(b))
-func Print(a ...interface{}) (n int, err error) {
-	return fmt.Print(convertArgs(a)...)
-}
-
-// Printf is a wrapper for fmt.Printf that treats each argument as if it were
-// passed with a default Formatter interface returned by NewFormatter.  It
-// returns the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Printf(format, spew.NewFormatter(a), spew.NewFormatter(b))
-func Printf(format string, a ...interface{}) (n int, err error) {
-	return fmt.Printf(format, convertArgs(a)...)
-}
-
-// Println is a wrapper for fmt.Println that treats each argument as if it were
-// passed with a default Formatter interface returned by NewFormatter.  It
-// returns the number of bytes written and any write error encountered.  See
-// NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Println(spew.NewFormatter(a), spew.NewFormatter(b))
-func Println(a ...interface{}) (n int, err error) {
-	return fmt.Println(convertArgs(a)...)
-}
-
-// Sprint is a wrapper for fmt.Sprint that treats each argument as if it were
-// passed with a default Formatter interface returned by NewFormatter.  It
-// returns the resulting string.  See NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Sprint(spew.NewFormatter(a), spew.NewFormatter(b))
-func Sprint(a ...interface{}) string {
-	return fmt.Sprint(convertArgs(a)...)
-}
-
-// Sprintf is a wrapper for fmt.Sprintf that treats each argument as if it were
-// passed with a default Formatter interface returned by NewFormatter.  It
-// returns the resulting string.  See NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Sprintf(format, spew.NewFormatter(a), spew.NewFormatter(b))
-func Sprintf(format string, a ...interface{}) string {
-	return fmt.Sprintf(format, convertArgs(a)...)
-}
-
-// Sprintln is a wrapper for fmt.Sprintln that treats each argument as if it
-// were passed with a default Formatter interface returned by NewFormatter.  It
-// returns the resulting string.  See NewFormatter for formatting details.
-//
-// This function is shorthand for the following syntax:
-//
-//	fmt.Sprintln(spew.NewFormatter(a), spew.NewFormatter(b))
-func Sprintln(a ...interface{}) string {
-	return fmt.Sprintln(convertArgs(a)...)
-}
-
-// convertArgs accepts a slice of arguments and returns a slice of the same
-// length with each argument converted to a default spew Formatter interface.
-func convertArgs(args []interface{}) (formatters []interface{}) {
-	formatters = make([]interface{}, len(args))
-	for index, arg := range args {
-		formatters[index] = NewFormatter(arg)
-	}
-	return formatters
-}

vendor/github.com/eclipse/paho.mqtt.golang/.gitignore

@@ -1,36 +0,0 @@
-# Compiled Object files, Static and Dynamic libs (Shared Objects)
-*.o
-*.a
-*.so
-
-# Folders
-_obj
-_test
-
-# Architecture specific extensions/prefixes
-*.[568vq]
-[568vq].out
-
-*.cgo1.go
-*.cgo2.c
-_cgo_defun.c
-_cgo_gotypes.go
-_cgo_export.*
-
-_testmain.go
-
-*.exe
-
-*.msg
-*.lok
-
-samples/trivial
-samples/trivial2
-samples/sample
-samples/reconnect
-samples/ssl
-samples/custom_store
-samples/simple
-samples/stdinpub
-samples/stdoutsub
-samples/routing

vendor/github.com/eclipse/paho.mqtt.golang/CONTRIBUTING.md

@@ -1,56 +0,0 @@
-Contributing to Paho
-====================
-
-Thanks for your interest in this project.
-
-Project description:
---------------------
-
-The Paho project has been created to provide scalable open-source implementations of open and standard messaging protocols aimed at new, existing, and emerging applications for Machine-to-Machine (M2M) and Internet of Things (IoT).
-Paho reflects the inherent physical and cost constraints of device connectivity. Its objectives include effective levels of decoupling between devices and applications, designed to keep markets open and encourage the rapid growth of scalable Web and Enterprise middleware and applications. Paho is being kicked off with MQTT publish/subscribe client implementations for use on embedded platforms, along with corresponding server support as determined by the community.
-
-- https://projects.eclipse.org/projects/technology.paho
-
-Developer resources:
---------------------
-
-Information regarding source code management, builds, coding standards, and more.
-
-- https://projects.eclipse.org/projects/technology.paho/developer
-
-Contributor License Agreement:
-------------------------------
-
-Before your contribution can be accepted by the project, you need to create and electronically sign the Eclipse Foundation Contributor License Agreement (CLA).
-
-- http://www.eclipse.org/legal/CLA.php
-
-Contributing Code:
-------------------
-
-The Go client is developed in Github, see their documentation on the process of forking and pull requests; https://help.github.com/categories/collaborating-on-projects-using-pull-requests/
-
-Git commit messages should follow the style described here;
-
-http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
-
-Contact:
---------
-
-Contact the project developers via the project's "dev" list.
-
-- https://dev.eclipse.org/mailman/listinfo/paho-dev
-
-Search for bugs:
-----------------
-
-This project uses Github issues to track ongoing development and issues.
-
-- https://github.com/eclipse/paho.mqtt.golang/issues
-
-Create a new bug:
------------------
-
-Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!
-
-- https://github.com/eclipse/paho.mqtt.golang/issues

vendor/github.com/eclipse/paho.mqtt.golang/LICENSE

@@ -1,294 +0,0 @@
-Eclipse Public License - v 2.0 (EPL-2.0)
-
-This program and the accompanying materials
-are made available under the terms of the Eclipse Public License v2.0
-and Eclipse Distribution License v1.0 which accompany this distribution.
-
-The Eclipse Public License is available at
-  https://www.eclipse.org/legal/epl-2.0/
-and the Eclipse Distribution License is available at
-  http://www.eclipse.org/org/documents/edl-v10.php.
-
-For an explanation of what dual-licensing means to you, see:
-https://www.eclipse.org/legal/eplfaq.php#DUALLIC
-
-****
-The epl-2.0 is copied below in order to pass the pkg.go.dev license check (https://pkg.go.dev/license-policy).
-****
-Eclipse Public License - v 2.0
-
-    THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
-    PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
-    OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
-
-1. DEFINITIONS
-
-"Contribution" means:
-
-  a) in the case of the initial Contributor, the initial content
-     Distributed under this Agreement, and
-
-  b) in the case of each subsequent Contributor:
-     i) changes to the Program, and
-     ii) additions to the Program;
-  where such changes and/or additions to the Program originate from
-  and are Distributed by that particular Contributor. A Contribution
-  "originates" from a Contributor if it was added to the Program by
-  such Contributor itself or anyone acting on such Contributor's behalf.
-  Contributions do not include changes or additions to the Program that
-  are not Modified Works.
-
-"Contributor" means any person or entity that Distributes the Program.
-
-"Licensed Patents" mean patent claims licensable by a Contributor which
-are necessarily infringed by the use or sale of its Contribution alone
-or when combined with the Program.
-
-"Program" means the Contributions Distributed in accordance with this
-Agreement.
-
-"Recipient" means anyone who receives the Program under this Agreement
-or any Secondary License (as applicable), including Contributors.
-
-"Derivative Works" shall mean any work, whether in Source Code or other
-form, that is based on (or derived from) the Program and for which the
-editorial revisions, annotations, elaborations, or other modifications
-represent, as a whole, an original work of authorship.
-
-"Modified Works" shall mean any work in Source Code or other form that
-results from an addition to, deletion from, or modification of the
-contents of the Program, including, for purposes of clarity any new file
-in Source Code form that contains any contents of the Program. Modified
-Works shall not include works that contain only declarations,
-interfaces, types, classes, structures, or files of the Program solely
-in each case in order to link to, bind by name, or subclass the Program
-or Modified Works thereof.
-
-"Distribute" means the acts of a) distributing or b) making available
-in any manner that enables the transfer of a copy.
-
-"Source Code" means the form of a Program preferred for making
-modifications, including but not limited to software source code,
-documentation source, and configuration files.
-
-"Secondary License" means either the GNU General Public License,
-Version 2.0, or any later versions of that license, including any
-exceptions or additional permissions as identified by the initial
-Contributor.
-
-2. GRANT OF RIGHTS
-
-  a) Subject to the terms of this Agreement, each Contributor hereby
-  grants Recipient a non-exclusive, worldwide, royalty-free copyright
-  license to reproduce, prepare Derivative Works of, publicly display,
-  publicly perform, Distribute and sublicense the Contribution of such
-  Contributor, if any, and such Derivative Works.
-
-  b) Subject to the terms of this Agreement, each Contributor hereby
-  grants Recipient a non-exclusive, worldwide, royalty-free patent
-  license under Licensed Patents to make, use, sell, offer to sell,
-  import and otherwise transfer the Contribution of such Contributor,
-  if any, in Source Code or other form. This patent license shall
-  apply to the combination of the Contribution and the Program if, at
-  the time the Contribution is added by the Contributor, such addition
-  of the Contribution causes such combination to be covered by the
-  Licensed Patents. The patent license shall not apply to any other
-  combinations which include the Contribution. No hardware per se is
-  licensed hereunder.
-
-  c) Recipient understands that although each Contributor grants the
-  licenses to its Contributions set forth herein, no assurances are
-  provided by any Contributor that the Program does not infringe the
-  patent or other intellectual property rights of any other entity.
-  Each Contributor disclaims any liability to Recipient for claims
-  brought by any other entity based on infringement of intellectual
-  property rights or otherwise. As a condition to exercising the
-  rights and licenses granted hereunder, each Recipient hereby
-  assumes sole responsibility to secure any other intellectual
-  property rights needed, if any. For example, if a third party
-  patent license is required to allow Recipient to Distribute the
-  Program, it is Recipient's responsibility to acquire that license
-  before distributing the Program.
-
-  d) Each Contributor represents that to its knowledge it has
-  sufficient copyright rights in its Contribution, if any, to grant
-  the copyright license set forth in this Agreement.
-
-  e) Notwithstanding the terms of any Secondary License, no
-  Contributor makes additional grants to any Recipient (other than
-  those set forth in this Agreement) as a result of such Recipient's
-  receipt of the Program under the terms of a Secondary License
-  (if permitted under the terms of Section 3).
-
-3. REQUIREMENTS
-
-3.1 If a Contributor Distributes the Program in any form, then:
-
-  a) the Program must also be made available as Source Code, in
-  accordance with section 3.2, and the Contributor must accompany
-  the Program with a statement that the Source Code for the Program
-  is available under this Agreement, and informs Recipients how to
-  obtain it in a reasonable manner on or through a medium customarily
-  used for software exchange; and
-
-  b) the Contributor may Distribute the Program under a license
-  different than this Agreement, provided that such license:
-     i) effectively disclaims on behalf of all other Contributors all
-     warranties and conditions, express and implied, including
-     warranties or conditions of title and non-infringement, and
-     implied warranties or conditions of merchantability and fitness
-     for a particular purpose;
-
-     ii) effectively excludes on behalf of all other Contributors all
-     liability for damages, including direct, indirect, special,
-     incidental and consequential damages, such as lost profits;
-
-     iii) does not attempt to limit or alter the recipients' rights
-     in the Source Code under section 3.2; and
-
-     iv) requires any subsequent distribution of the Program by any
-     party to be under a license that satisfies the requirements
-     of this section 3.
-
-3.2 When the Program is Distributed as Source Code:
-
-  a) it must be made available under this Agreement, or if the
-  Program (i) is combined with other material in a separate file or
-  files made available under a Secondary License, and (ii) the initial
-  Contributor attached to the Source Code the notice described in
-  Exhibit A of this Agreement, then the Program may be made available
-  under the terms of such Secondary Licenses, and
-
-  b) a copy of this Agreement must be included with each copy of
-  the Program.
-
-3.3 Contributors may not remove or alter any copyright, patent,
-trademark, attribution notices, disclaimers of warranty, or limitations
-of liability ("notices") contained within the Program from any copy of
-the Program which they Distribute, provided that Contributors may add
-their own appropriate notices.
-
-4. COMMERCIAL DISTRIBUTION
-
-Commercial distributors of software may accept certain responsibilities
-with respect to end users, business partners and the like. While this
-license is intended to facilitate the commercial use of the Program,
-the Contributor who includes the Program in a commercial product
-offering should do so in a manner which does not create potential
-liability for other Contributors. Therefore, if a Contributor includes
-the Program in a commercial product offering, such Contributor
-("Commercial Contributor") hereby agrees to defend and indemnify every
-other Contributor ("Indemnified Contributor") against any losses,
-damages and costs (collectively "Losses") arising from claims, lawsuits
-and other legal actions brought by a third party against the Indemnified
-Contributor to the extent caused by the acts or omissions of such
-Commercial Contributor in connection with its distribution of the Program
-in a commercial product offering. The obligations in this section do not
-apply to any claims or Losses relating to any actual or alleged
-intellectual property infringement. In order to qualify, an Indemnified
-Contributor must: a) promptly notify the Commercial Contributor in
-writing of such claim, and b) allow the Commercial Contributor to control,
-and cooperate with the Commercial Contributor in, the defense and any
-related settlement negotiations. The Indemnified Contributor may
-participate in any such claim at its own expense.
-
-For example, a Contributor might include the Program in a commercial
-product offering, Product X. That Contributor is then a Commercial
-Contributor. If that Commercial Contributor then makes performance
-claims, or offers warranties related to Product X, those performance
-claims and warranties are such Commercial Contributor's responsibility
-alone. Under this section, the Commercial Contributor would have to
-defend claims against the other Contributors related to those performance
-claims and warranties, and if a court requires any other Contributor to
-pay any damages as a result, the Commercial Contributor must pay
-those damages.
-
-5. NO WARRANTY
-
-EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
-PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
-BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
-IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
-TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
-PURPOSE. Each Recipient is solely responsible for determining the
-appropriateness of using and distributing the Program and assumes all
-risks associated with its exercise of rights under this Agreement,
-including but not limited to the risks and costs of program errors,
-compliance with applicable laws, damage to or loss of data, programs
-or equipment, and unavailability or interruption of operations.
-
-6. DISCLAIMER OF LIABILITY
-
-EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
-PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
-SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
-PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
-EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
-7. GENERAL
-
-If any provision of this Agreement is invalid or unenforceable under
-applicable law, it shall not affect the validity or enforceability of
-the remainder of the terms of this Agreement, and without further
-action by the parties hereto, such provision shall be reformed to the
-minimum extent necessary to make such provision valid and enforceable.
-
-If Recipient institutes patent litigation against any entity
-(including a cross-claim or counterclaim in a lawsuit) alleging that the
-Program itself (excluding combinations of the Program with other software
-or hardware) infringes such Recipient's patent(s), then such Recipient's
-rights granted under Section 2(b) shall terminate as of the date such
-litigation is filed.
-
-All Recipient's rights under this Agreement shall terminate if it
-fails to comply with any of the material terms or conditions of this
-Agreement and does not cure such failure in a reasonable period of
-time after becoming aware of such noncompliance. If all Recipient's
-rights under this Agreement terminate, Recipient agrees to cease use
-and distribution of the Program as soon as reasonably practicable.
-However, Recipient's obligations under this Agreement and any licenses
-granted by Recipient relating to the Program shall continue and survive.
-
-Everyone is permitted to copy and distribute copies of this Agreement,
-but in order to avoid inconsistency the Agreement is copyrighted and
-may only be modified in the following manner. The Agreement Steward
-reserves the right to publish new versions (including revisions) of
-this Agreement from time to time. No one other than the Agreement
-Steward has the right to modify this Agreement. The Eclipse Foundation
-is the initial Agreement Steward. The Eclipse Foundation may assign the
-responsibility to serve as the Agreement Steward to a suitable separate
-entity. Each new version of the Agreement will be given a distinguishing
-version number. The Program (including Contributions) may always be
-Distributed subject to the version of the Agreement under which it was
-received. In addition, after a new version of the Agreement is published,
-Contributor may elect to Distribute the Program (including its
-Contributions) under the new version.
-
-Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
-receives no rights or licenses to the intellectual property of any
-Contributor under this Agreement, whether expressly, by implication,
-estoppel or otherwise. All rights in the Program not expressly granted
-under this Agreement are reserved. Nothing in this Agreement is intended
-to be enforceable by any entity that is not a Contributor or Recipient.
-No third-party beneficiary rights are created under this Agreement.
-
-Exhibit A - Form of Secondary Licenses Notice
-
-"This Source Code may also be made available under the following
-Secondary Licenses when the conditions for such availability set forth
-in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
-version(s), and exceptions or additional permissions here}."
-
-  Simply including a copy of this Agreement, including this Exhibit A
-  is not sufficient to license the Source Code under Secondary Licenses.
-
-  If it is not possible or desirable to put the notice in a particular
-  file, then You may include the notice in a location (such as a LICENSE
-  file in a relevant directory) where a recipient would be likely to
-  look for such a notice.
-
-  You may add additional accurate notices of copyright ownership.

vendor/github.com/eclipse/paho.mqtt.golang/NOTICE.md

@@ -1,77 +0,0 @@
-# Notices for paho.mqtt.golang
-
-This content is produced and maintained by the Eclipse Paho project.
-
- * Project home: https://www.eclipse.org/paho/
-
-Note that a [separate mqtt v5 client](https://github.com/eclipse/paho.golang) also exists (this is a full rewrite
-and deliberately incompatible with this library).
-
-## Trademarks
-
-Eclipse Mosquitto trademarks of the Eclipse Foundation. Eclipse, and the
-Eclipse Logo are registered trademarks of the Eclipse Foundation.
-
-Paho is a trademark of the Eclipse Foundation. Eclipse, and the Eclipse Logo are
-registered trademarks of the Eclipse Foundation.
-
-## Copyright
-
-All content is the property of the respective authors or their employers.
-For more information regarding authorship of content, please consult the
-listed source code repository logs.
-
-## Declared Project Licenses
-
-This program and the accompanying materials are made available under the terms of the 
-Eclipse Public License v2.0 and Eclipse Distribution License v1.0 which accompany this
-distribution.
-
-The Eclipse Public License is available at
-https://www.eclipse.org/legal/epl-2.0/
-and the Eclipse Distribution License is available at
-http://www.eclipse.org/org/documents/edl-v10.php.
-
-For an explanation of what dual-licensing means to you, see:
-https://www.eclipse.org/legal/eplfaq.php#DUALLIC
-
-SPDX-License-Identifier: EPL-2.0 or BSD-3-Clause
-
-## Source Code
-
-The project maintains the following source code repositories:
-
- * https://github.com/eclipse/paho.mqtt.golang
-
-## Third-party Content
-
-This project makes use of the follow third party projects.
-
-Go Programming Language and Standard Library
-
-* License: BSD-style license (https://golang.org/LICENSE)
-* Project: https://golang.org/
-
-Go Networking
-
-* License: BSD 3-Clause style license and patent grant.
-* Project: https://cs.opensource.google/go/x/net
-
-Go Sync
-
-* License: BSD 3-Clause style license and patent grant.
-* Project: https://cs.opensource.google/go/x/sync/
-
-Gorilla Websockets v1.4.2
-
-* License: BSD 2-Clause "Simplified" License
-* Project: https://github.com/gorilla/websocket
-
-## Cryptography
-
-Content may contain encryption software. The country in which you are currently
-may have restrictions on the import, possession, and use, and/or re-export to
-another country, of encryption software. BEFORE using any encryption software,
-please check the country's laws, regulations and policies concerning the import,
-possession, or use, and re-export of encryption software, to see if this is
-permitted.

vendor/github.com/eclipse/paho.mqtt.golang/README.md

@@ -1,198 +0,0 @@
-
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/eclipse/paho.mqtt.golang)](https://pkg.go.dev/github.com/eclipse/paho.mqtt.golang)
-[![Go Report Card](https://goreportcard.com/badge/github.com/eclipse/paho.mqtt.golang)](https://goreportcard.com/report/github.com/eclipse/paho.mqtt.golang)
-
-Eclipse Paho MQTT Go client
-===========================
-
-
-This repository contains the source code for the [Eclipse Paho](https://eclipse.org/paho) MQTT 3.1/3.11 Go client library. 
-
-This code builds a library which enable applications to connect to an [MQTT](https://mqtt.org) broker to publish 
-messages, and to subscribe to topics and receive published messages.
-
-This library supports a fully asynchronous mode of operation.
-
-A client supporting MQTT V5 is [also available](https://github.com/eclipse/paho.golang).
-
-Installation and Build
-----------------------
-
-The process depends upon whether you are using [modules](https://golang.org/ref/mod) (recommended) or `GOPATH`. 
-
-#### Modules
-
-If you are using [modules](https://blog.golang.org/using-go-modules) then `import "github.com/eclipse/paho.mqtt.golang"` 
-and start using it. The necessary packages will be download automatically when you run `go build`. 
-
-Note that the latest release will be downloaded and changes may have been made since the release. If you have 
-encountered an issue, or wish to try the latest code for another reason, then run 
-`go get github.com/eclipse/paho.mqtt.golang@master` to get the latest commit.
-
-#### GOPATH
-
-Installation is as easy as:
-
-```
-go get github.com/eclipse/paho.mqtt.golang
-```
-
-The client depends on Google's [proxy](https://godoc.org/golang.org/x/net/proxy) package and the 
-[websockets](https://godoc.org/github.com/gorilla/websocket) package, also easily installed with the commands:
-
-```
-go get github.com/gorilla/websocket
-go get golang.org/x/net/proxy
-```
-
-
-Usage and API
--------------
-
-Detailed API documentation is available by using to godoc tool, or can be browsed online
-using the [pkg.go.dev](https://pkg.go.dev/github.com/eclipse/paho.mqtt.golang) service.
-
-Samples are available in the `cmd` directory for reference.
-
-Note:
-
-The library also supports using MQTT over websockets by using the `ws://` (unsecure) or `wss://` (secure) prefix in the
-URI. If the client is running behind a corporate http/https proxy then the following environment variables `HTTP_PROXY`,
-`HTTPS_PROXY` and `NO_PROXY` are taken into account when establishing the connection.
-
-Troubleshooting
----------------
-
-If you are new to MQTT and your application is not working as expected reviewing the
-[MQTT specification](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html), which this library implements,
-is a good first step. [MQTT.org](https://mqtt.org) has some [good resources](https://mqtt.org/getting-started/) that answer many 
-common questions.
-
-### Error Handling
-
-The asynchronous nature of this library makes it easy to forget to check for errors. Consider using a go routine to 
-log these: 
-
-```go
-t := client.Publish("topic", qos, retained, msg)
-go func() {
-    _ = t.Wait() // Can also use '<-t.Done()' in releases > 1.2.0
-    if t.Error() != nil {
-        log.Error(t.Error()) // Use your preferred logging technique (or just fmt.Printf)
-    }
-}()
-```
-
-### Logging
-
-If you are encountering issues then enabling logging, both within this library and on your broker, is a good way to
-begin troubleshooting. This library can produce various levels of log by assigning the logging endpoints, ERROR, 
-CRITICAL, WARN and DEBUG. For example:
-
-```go
-func main() {
-	mqtt.ERROR = log.New(os.Stdout, "[ERROR] ", 0)
-	mqtt.CRITICAL = log.New(os.Stdout, "[CRIT] ", 0)
-	mqtt.WARN = log.New(os.Stdout, "[WARN]  ", 0)
-	mqtt.DEBUG = log.New(os.Stdout, "[DEBUG] ", 0)
-
-	// Connect, Subscribe, Publish etc..
-}
-```
-
-### Common Problems
-
-* Seemingly random disconnections may be caused by another client connecting to the broker with the same client 
-identifier; this is as per the [spec](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc384800405).
-* Unless ordered delivery of messages is essential (and you have configured your broker to support this e.g. 
-  `max_inflight_messages=1` in mosquitto) then set `ClientOptions.SetOrderMatters(false)`. Doing so will avoid the 
-  below issue (deadlocks due to blocking message handlers).
-* A `MessageHandler` (called when a new message is received) must not block (unless 
-  `ClientOptions.SetOrderMatters(false)` set). If you wish to perform a long-running task, or publish a message, then 
-  please use a go routine (blocking in the handler is a common cause of unexpected `pingresp 
-not received, disconnecting` errors). 
-* When QOS1+ subscriptions have been created previously and you connect with `CleanSession` set to false it is possible 
-that the broker will deliver retained messages before `Subscribe` can be called. To process these messages either 
-configure a handler with `AddRoute` or set a `DefaultPublishHandler`. If there is no handler (or `DefaultPublishHandler`) 
-then inbound messages will not be acknowledged. Adding a handler (even if it's  `opts.SetDefaultPublishHandler(func(mqtt.Client, mqtt.Message) {})`) 
-is highly recommended to avoid inadvertently hitting inflight message limits.
-* Loss of network connectivity may not be detected immediately. If this is an issue then consider setting 
-`ClientOptions.KeepAlive` (sends regular messages to check the link is active).
-* Reusing a `Client` is not completely safe. After calling `Disconnect` please create a new Client (`NewClient()`) rather 
-than attempting to reuse the existing one (note that features such as `SetAutoReconnect` mean this is rarely necessary).
-* Brokers offer many configuration options; some settings may lead to unexpected results.
-* Publish tokens will complete if the connection is lost and re-established using the default
-options.SetAutoReconnect(true) functionality (token.Error() will return nil). Attempts will be made to re-deliver the
-message but there is currently no easy way know when such messages are delivered.
-
-If using Mosquitto then there are a range of fairly common issues:
-* `listener` - By default [Mosquitto v2+](https://mosquitto.org/documentation/migrating-to-2-0/) listens on loopback 
-interfaces only (meaning it will only accept connections made from the computer its running on).
-* `max_inflight_messages` - Unless this is set to 1 mosquitto does not guarantee ordered delivery of messages. 
-* `max_queued_messages` / `max_queued_bytes` - These impose limits on the number/size of queued messages. The defaults
-may lead to messages being silently dropped.
-* `persistence` - Defaults to false (messages will not survive a broker restart)
-* `max_keepalive` - defaults to 65535 and, from version 2.0.12, `SetKeepAlive(0)` will result in a rejected connection 
-by default.
-
-Reporting bugs
---------------
-
-Please report bugs by raising issues for this project in github https://github.com/eclipse/paho.mqtt.golang/issues
-
-A limited number of contributors monitor the issues section so if you have a general question please see the 
-resources in the [more information](#more-information) section for help.
-
-We welcome bug reports, but it is important they are actionable. A significant percentage of issues reported are not 
-resolved due to a lack of information. If we cannot replicate the problem then it is unlikely we will be able to fix it. 
-The information required will vary from issue to issue but almost all bug reports would be expected to include: 
-
-* Which version of the package you are using (tag or commit - this should be in your `go.mod` file)
-* A full, clear, description of the problem (detail what you are expecting vs what actually happens).
-* Configuration information (code showing how you connect, please include all references to `ClientOption`)
-* Broker details (name and version).
-
-If at all possible please also include:
-* Details of your attempts to resolve the issue (what have you tried, what worked, what did not).
-* A [Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example). Providing an example
-is the best way to demonstrate the issue you are facing; it is important this includes all relevant information
-(including broker configuration). Docker (see `cmd/docker`) makes it relatively simple to provide a working end-to-end
-example.
-* Broker logs covering the period the issue occurred.
-* [Application Logs](#logging) covering the period the issue occurred. Unless you have isolated the root cause of the 
-issue please include a link to a full log (including data from well before the problem arose).
-
-It is important to remember that this library does not stand alone; it communicates with a broker and any issues you are 
-seeing may be due to:
-
-* Bugs in your code.
-* Bugs in this library.
-* The broker configuration.
-* Bugs in the broker.
-* Issues with whatever you are communicating with.
-
-When submitting an issue, please ensure that you provide sufficient details to enable us to eliminate causes outside of
-this library.
-
-Contributing
-------------
-
-We welcome pull requests but before your contribution can be accepted by the project, you need to create and 
-electronically sign the Eclipse Contributor Agreement (ECA) and sign off on the Eclipse Foundation Certificate of Origin.
-
-More information is available in the 
-[Eclipse Development Resources](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git); please take special 
-note of the requirement that the commit record contain a "Signed-off-by" entry.
-
-More information
-----------------
-
-[Stack Overflow](https://stackoverflow.com/questions/tagged/mqtt+go) has a range questions/answers covering a range of 
-common issues (both relating to use of this library and MQTT in general). This is the best place to ask general questions 
-(including those relating to the use of this library).
-
-Discussion of the Paho clients takes place on the [Eclipse paho-dev mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
-
-General questions about the MQTT protocol are discussed in the [MQTT Google Group](https://groups.google.com/forum/?hl=en-US&fromgroups#!forum/mqtt).
-
-There is much more information available via the [MQTT community site](http://mqtt.org).

vendor/github.com/eclipse/paho.mqtt.golang/backoff.go

@@ -1,104 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Matt Brittan
- *    Daichi Tomaru
- */
-
-package mqtt
-
-import (
-	"sync"
-	"time"
-)
-
-// Controller for sleep with backoff when the client attempts reconnection
-// It has statuses for each situations cause reconnection.
-type backoffController struct {
-	sync.RWMutex
-	statusMap map[string]*backoffStatus
-}
-
-type backoffStatus struct {
-	lastSleepPeriod time.Duration
-	lastErrorTime   time.Time
-}
-
-func newBackoffController() *backoffController {
-	return &backoffController{
-		statusMap: map[string]*backoffStatus{},
-	}
-}
-
-// Calculate next sleep period from the specified parameters.
-// Returned values are next sleep period and whether the error situation is continual.
-// If connection errors continuouslly occurs, its sleep period is exponentially increased.
-// Also if there is a lot of time between last and this error, sleep period is initialized.
-func (b *backoffController) getBackoffSleepTime(
-	situation string, initSleepPeriod time.Duration, maxSleepPeriod time.Duration, processTime time.Duration, skipFirst bool,
-) (time.Duration, bool) {
-	// Decide first sleep time if the situation is not continual. 
-	var firstProcess = func(status *backoffStatus, init time.Duration, skip bool) (time.Duration, bool) {
-		if skip {
-			status.lastSleepPeriod = 0
-			return 0, false
-		}
-		status.lastSleepPeriod = init
-		return init, false
-	}
-
-	// Prioritize maxSleep.
-	if initSleepPeriod > maxSleepPeriod {
-		initSleepPeriod = maxSleepPeriod
-	}
-	b.Lock()
-	defer b.Unlock()
-
-	status, exist := b.statusMap[situation]
-	if !exist {
-		b.statusMap[situation] = &backoffStatus{initSleepPeriod, time.Now()}
-		return firstProcess(b.statusMap[situation], initSleepPeriod, skipFirst)
-	}
-
-	oldTime := status.lastErrorTime
-	status.lastErrorTime = time.Now()
-
-	// When there is a lot of time between last and this error, sleep period is initialized.
-	if status.lastErrorTime.Sub(oldTime) > (processTime * 2 + status.lastSleepPeriod) {
-		return firstProcess(status, initSleepPeriod, skipFirst)
-	}
-
-	if status.lastSleepPeriod == 0 {
-		status.lastSleepPeriod = initSleepPeriod
-		return initSleepPeriod, true
-	}
-
-	if nextSleepPeriod := status.lastSleepPeriod * 2; nextSleepPeriod <= maxSleepPeriod {
-		status.lastSleepPeriod = nextSleepPeriod
-	} else {
-		status.lastSleepPeriod = maxSleepPeriod
-	}
-
-	return status.lastSleepPeriod, true
-}
-
-// Execute sleep the time returned from getBackoffSleepTime.
-func (b *backoffController) sleepWithBackoff(
-	situation string, initSleepPeriod time.Duration, maxSleepPeriod time.Duration, processTime time.Duration, skipFirst bool,
-) (time.Duration, bool) {
-	sleep, isFirst := b.getBackoffSleepTime(situation, initSleepPeriod, maxSleepPeriod, processTime, skipFirst)
-	if sleep != 0 {
-		time.Sleep(sleep)
-	}
-	return sleep, isFirst
-}

vendor/github.com/eclipse/paho.mqtt.golang/components.go

@@ -1,36 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- */
-
-package mqtt
-
-type component string
-
-// Component names for debug output
-const (
-	NET component = "[net]     "
-	PNG component = "[pinger]  "
-	CLI component = "[client]  "
-	DEC component = "[decode]  "
-	MES component = "[message] "
-	STR component = "[store]   "
-	MID component = "[msgids]  "
-	TST component = "[test]    "
-	STA component = "[state]   "
-	ERR component = "[error]   "
-	ROU component = "[router]  "
-)

vendor/github.com/eclipse/paho.mqtt.golang/edl-v10

@@ -1,15 +0,0 @@
-
-Eclipse Distribution License - v 1.0
-
-Copyright (c) 2007, Eclipse Foundation, Inc. and its licensors.
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-    Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-    Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-    Neither the name of the Eclipse Foundation, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

vendor/github.com/eclipse/paho.mqtt.golang/epl-v20

@@ -1,277 +0,0 @@
-Eclipse Public License - v 2.0
-
-    THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
-    PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
-    OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
-
-1. DEFINITIONS
-
-"Contribution" means:
-
-  a) in the case of the initial Contributor, the initial content
-     Distributed under this Agreement, and
-
-  b) in the case of each subsequent Contributor:
-     i) changes to the Program, and
-     ii) additions to the Program;
-  where such changes and/or additions to the Program originate from
-  and are Distributed by that particular Contributor. A Contribution
-  "originates" from a Contributor if it was added to the Program by
-  such Contributor itself or anyone acting on such Contributor's behalf.
-  Contributions do not include changes or additions to the Program that
-  are not Modified Works.
-
-"Contributor" means any person or entity that Distributes the Program.
-
-"Licensed Patents" mean patent claims licensable by a Contributor which
-are necessarily infringed by the use or sale of its Contribution alone
-or when combined with the Program.
-
-"Program" means the Contributions Distributed in accordance with this
-Agreement.
-
-"Recipient" means anyone who receives the Program under this Agreement
-or any Secondary License (as applicable), including Contributors.
-
-"Derivative Works" shall mean any work, whether in Source Code or other
-form, that is based on (or derived from) the Program and for which the
-editorial revisions, annotations, elaborations, or other modifications
-represent, as a whole, an original work of authorship.
-
-"Modified Works" shall mean any work in Source Code or other form that
-results from an addition to, deletion from, or modification of the
-contents of the Program, including, for purposes of clarity any new file
-in Source Code form that contains any contents of the Program. Modified
-Works shall not include works that contain only declarations,
-interfaces, types, classes, structures, or files of the Program solely
-in each case in order to link to, bind by name, or subclass the Program
-or Modified Works thereof.
-
-"Distribute" means the acts of a) distributing or b) making available
-in any manner that enables the transfer of a copy.
-
-"Source Code" means the form of a Program preferred for making
-modifications, including but not limited to software source code,
-documentation source, and configuration files.
-
-"Secondary License" means either the GNU General Public License,
-Version 2.0, or any later versions of that license, including any
-exceptions or additional permissions as identified by the initial
-Contributor.
-
-2. GRANT OF RIGHTS
-
-  a) Subject to the terms of this Agreement, each Contributor hereby
-  grants Recipient a non-exclusive, worldwide, royalty-free copyright
-  license to reproduce, prepare Derivative Works of, publicly display,
-  publicly perform, Distribute and sublicense the Contribution of such
-  Contributor, if any, and such Derivative Works.
-
-  b) Subject to the terms of this Agreement, each Contributor hereby
-  grants Recipient a non-exclusive, worldwide, royalty-free patent
-  license under Licensed Patents to make, use, sell, offer to sell,
-  import and otherwise transfer the Contribution of such Contributor,
-  if any, in Source Code or other form. This patent license shall
-  apply to the combination of the Contribution and the Program if, at
-  the time the Contribution is added by the Contributor, such addition
-  of the Contribution causes such combination to be covered by the
-  Licensed Patents. The patent license shall not apply to any other
-  combinations which include the Contribution. No hardware per se is
-  licensed hereunder.
-
-  c) Recipient understands that although each Contributor grants the
-  licenses to its Contributions set forth herein, no assurances are
-  provided by any Contributor that the Program does not infringe the
-  patent or other intellectual property rights of any other entity.
-  Each Contributor disclaims any liability to Recipient for claims
-  brought by any other entity based on infringement of intellectual
-  property rights or otherwise. As a condition to exercising the
-  rights and licenses granted hereunder, each Recipient hereby
-  assumes sole responsibility to secure any other intellectual
-  property rights needed, if any. For example, if a third party
-  patent license is required to allow Recipient to Distribute the
-  Program, it is Recipient's responsibility to acquire that license
-  before distributing the Program.
-
-  d) Each Contributor represents that to its knowledge it has
-  sufficient copyright rights in its Contribution, if any, to grant
-  the copyright license set forth in this Agreement.
-
-  e) Notwithstanding the terms of any Secondary License, no
-  Contributor makes additional grants to any Recipient (other than
-  those set forth in this Agreement) as a result of such Recipient's
-  receipt of the Program under the terms of a Secondary License
-  (if permitted under the terms of Section 3).
-
-3. REQUIREMENTS
-
-3.1 If a Contributor Distributes the Program in any form, then:
-
-  a) the Program must also be made available as Source Code, in
-  accordance with section 3.2, and the Contributor must accompany
-  the Program with a statement that the Source Code for the Program
-  is available under this Agreement, and informs Recipients how to
-  obtain it in a reasonable manner on or through a medium customarily
-  used for software exchange; and
-
-  b) the Contributor may Distribute the Program under a license
-  different than this Agreement, provided that such license:
-     i) effectively disclaims on behalf of all other Contributors all
-     warranties and conditions, express and implied, including
-     warranties or conditions of title and non-infringement, and
-     implied warranties or conditions of merchantability and fitness
-     for a particular purpose;
-
-     ii) effectively excludes on behalf of all other Contributors all
-     liability for damages, including direct, indirect, special,
-     incidental and consequential damages, such as lost profits;
-
-     iii) does not attempt to limit or alter the recipients' rights
-     in the Source Code under section 3.2; and
-
-     iv) requires any subsequent distribution of the Program by any
-     party to be under a license that satisfies the requirements
-     of this section 3.
-
-3.2 When the Program is Distributed as Source Code:
-
-  a) it must be made available under this Agreement, or if the
-  Program (i) is combined with other material in a separate file or
-  files made available under a Secondary License, and (ii) the initial
-  Contributor attached to the Source Code the notice described in
-  Exhibit A of this Agreement, then the Program may be made available
-  under the terms of such Secondary Licenses, and
-
-  b) a copy of this Agreement must be included with each copy of
-  the Program.
-
-3.3 Contributors may not remove or alter any copyright, patent,
-trademark, attribution notices, disclaimers of warranty, or limitations
-of liability ("notices") contained within the Program from any copy of
-the Program which they Distribute, provided that Contributors may add
-their own appropriate notices.
-
-4. COMMERCIAL DISTRIBUTION
-
-Commercial distributors of software may accept certain responsibilities
-with respect to end users, business partners and the like. While this
-license is intended to facilitate the commercial use of the Program,
-the Contributor who includes the Program in a commercial product
-offering should do so in a manner which does not create potential
-liability for other Contributors. Therefore, if a Contributor includes
-the Program in a commercial product offering, such Contributor
-("Commercial Contributor") hereby agrees to defend and indemnify every
-other Contributor ("Indemnified Contributor") against any losses,
-damages and costs (collectively "Losses") arising from claims, lawsuits
-and other legal actions brought by a third party against the Indemnified
-Contributor to the extent caused by the acts or omissions of such
-Commercial Contributor in connection with its distribution of the Program
-in a commercial product offering. The obligations in this section do not
-apply to any claims or Losses relating to any actual or alleged
-intellectual property infringement. In order to qualify, an Indemnified
-Contributor must: a) promptly notify the Commercial Contributor in
-writing of such claim, and b) allow the Commercial Contributor to control,
-and cooperate with the Commercial Contributor in, the defense and any
-related settlement negotiations. The Indemnified Contributor may
-participate in any such claim at its own expense.
-
-For example, a Contributor might include the Program in a commercial
-product offering, Product X. That Contributor is then a Commercial
-Contributor. If that Commercial Contributor then makes performance
-claims, or offers warranties related to Product X, those performance
-claims and warranties are such Commercial Contributor's responsibility
-alone. Under this section, the Commercial Contributor would have to
-defend claims against the other Contributors related to those performance
-claims and warranties, and if a court requires any other Contributor to
-pay any damages as a result, the Commercial Contributor must pay
-those damages.
-
-5. NO WARRANTY
-
-EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
-PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
-BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
-IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
-TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
-PURPOSE. Each Recipient is solely responsible for determining the
-appropriateness of using and distributing the Program and assumes all
-risks associated with its exercise of rights under this Agreement,
-including but not limited to the risks and costs of program errors,
-compliance with applicable laws, damage to or loss of data, programs
-or equipment, and unavailability or interruption of operations.
-
-6. DISCLAIMER OF LIABILITY
-
-EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
-PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
-SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
-PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
-EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
-7. GENERAL
-
-If any provision of this Agreement is invalid or unenforceable under
-applicable law, it shall not affect the validity or enforceability of
-the remainder of the terms of this Agreement, and without further
-action by the parties hereto, such provision shall be reformed to the
-minimum extent necessary to make such provision valid and enforceable.
-
-If Recipient institutes patent litigation against any entity
-(including a cross-claim or counterclaim in a lawsuit) alleging that the
-Program itself (excluding combinations of the Program with other software
-or hardware) infringes such Recipient's patent(s), then such Recipient's
-rights granted under Section 2(b) shall terminate as of the date such
-litigation is filed.
-
-All Recipient's rights under this Agreement shall terminate if it
-fails to comply with any of the material terms or conditions of this
-Agreement and does not cure such failure in a reasonable period of
-time after becoming aware of such noncompliance. If all Recipient's
-rights under this Agreement terminate, Recipient agrees to cease use
-and distribution of the Program as soon as reasonably practicable.
-However, Recipient's obligations under this Agreement and any licenses
-granted by Recipient relating to the Program shall continue and survive.
-
-Everyone is permitted to copy and distribute copies of this Agreement,
-but in order to avoid inconsistency the Agreement is copyrighted and
-may only be modified in the following manner. The Agreement Steward
-reserves the right to publish new versions (including revisions) of
-this Agreement from time to time. No one other than the Agreement
-Steward has the right to modify this Agreement. The Eclipse Foundation
-is the initial Agreement Steward. The Eclipse Foundation may assign the
-responsibility to serve as the Agreement Steward to a suitable separate
-entity. Each new version of the Agreement will be given a distinguishing
-version number. The Program (including Contributions) may always be
-Distributed subject to the version of the Agreement under which it was
-received. In addition, after a new version of the Agreement is published,
-Contributor may elect to Distribute the Program (including its
-Contributions) under the new version.
-
-Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
-receives no rights or licenses to the intellectual property of any
-Contributor under this Agreement, whether expressly, by implication,
-estoppel or otherwise. All rights in the Program not expressly granted
-under this Agreement are reserved. Nothing in this Agreement is intended
-to be enforceable by any entity that is not a Contributor or Recipient.
-No third-party beneficiary rights are created under this Agreement.
-
-Exhibit A - Form of Secondary Licenses Notice
-
-"This Source Code may also be made available under the following
-Secondary Licenses when the conditions for such availability set forth
-in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
-version(s), and exceptions or additional permissions here}."
-
-  Simply including a copy of this Agreement, including this Exhibit A
-  is not sufficient to license the Source Code under Secondary Licenses.
-
-  If it is not possible or desirable to put the notice in a particular
-  file, then You may include the notice in a location (such as a LICENSE
-  file in a relevant directory) where a recipient would be likely to
-  look for such a notice.
-
-  You may add additional accurate notices of copyright ownership.

vendor/github.com/eclipse/paho.mqtt.golang/filestore.go

@@ -1,266 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- */
-
-package mqtt
-
-import (
-	"io/fs"
-	"os"
-	"path"
-	"sort"
-	"sync"
-
-	"github.com/eclipse/paho.mqtt.golang/packets"
-)
-
-const (
-	msgExt     = ".msg"
-	tmpExt     = ".tmp"
-	corruptExt = ".CORRUPT"
-)
-
-// FileStore implements the store interface using the filesystem to provide
-// true persistence, even across client failure. This is designed to use a
-// single directory per running client. If you are running multiple clients
-// on the same filesystem, you will need to be careful to specify unique
-// store directories for each.
-type FileStore struct {
-	sync.RWMutex
-	directory string
-	opened    bool
-}
-
-// NewFileStore will create a new FileStore which stores its messages in the
-// directory provided.
-func NewFileStore(directory string) *FileStore {
-	store := &FileStore{
-		directory: directory,
-		opened:    false,
-	}
-	return store
-}
-
-// Open will allow the FileStore to be used.
-func (store *FileStore) Open() {
-	store.Lock()
-	defer store.Unlock()
-	// if no store directory was specified in ClientOpts, by default use the
-	// current working directory
-	if store.directory == "" {
-		store.directory, _ = os.Getwd()
-	}
-
-	// if store dir exists, great, otherwise, create it
-	if !exists(store.directory) {
-		perms := os.FileMode(0770)
-		merr := os.MkdirAll(store.directory, perms)
-		chkerr(merr)
-	}
-	store.opened = true
-	DEBUG.Println(STR, "store is opened at", store.directory)
-}
-
-// Close will disallow the FileStore from being used.
-func (store *FileStore) Close() {
-	store.Lock()
-	defer store.Unlock()
-	store.opened = false
-	DEBUG.Println(STR, "store is closed")
-}
-
-// Put will put a message into the store, associated with the provided
-// key value.
-func (store *FileStore) Put(key string, m packets.ControlPacket) {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use file store, but not open")
-		return
-	}
-	full := fullpath(store.directory, key)
-	write(store.directory, key, m)
-	if !exists(full) {
-		ERROR.Println(STR, "file not created:", full)
-	}
-}
-
-// Get will retrieve a message from the store, the one associated with
-// the provided key value.
-func (store *FileStore) Get(key string) packets.ControlPacket {
-	store.RLock()
-	defer store.RUnlock()
-	if !store.opened {
-		ERROR.Println(STR, "trying to use file store, but not open")
-		return nil
-	}
-	filepath := fullpath(store.directory, key)
-	if !exists(filepath) {
-		return nil
-	}
-	mfile, oerr := os.Open(filepath)
-	chkerr(oerr)
-	msg, rerr := packets.ReadPacket(mfile)
-	chkerr(mfile.Close())
-
-	// Message was unreadable, return nil
-	if rerr != nil {
-		newpath := corruptpath(store.directory, key)
-		WARN.Println(STR, "corrupted file detected:", rerr.Error(), "archived at:", newpath)
-		if err := os.Rename(filepath, newpath); err != nil {
-			ERROR.Println(STR, err)
-		}
-		return nil
-	}
-	return msg
-}
-
-// All will provide a list of all of the keys associated with messages
-// currently residing in the FileStore.
-func (store *FileStore) All() []string {
-	store.RLock()
-	defer store.RUnlock()
-	return store.all()
-}
-
-// Del will remove the persisted message associated with the provided
-// key from the FileStore.
-func (store *FileStore) Del(key string) {
-	store.Lock()
-	defer store.Unlock()
-	store.del(key)
-}
-
-// Reset will remove all persisted messages from the FileStore.
-func (store *FileStore) Reset() {
-	store.Lock()
-	defer store.Unlock()
-	WARN.Println(STR, "FileStore Reset")
-	for _, key := range store.all() {
-		store.del(key)
-	}
-}
-
-// lockless
-func (store *FileStore) all() []string {
-	var err error
-	var keys []string
-
-	if !store.opened {
-		ERROR.Println(STR, "trying to use file store, but not open")
-		return nil
-	}
-
-	entries, err := os.ReadDir(store.directory)
-	chkerr(err)
-	files := make(fileInfos, 0, len(entries))
-	for _, entry := range entries {
-		info, err := entry.Info()
-		chkerr(err)
-		files = append(files, info)
-	}
-	sort.Sort(files)
-	for _, f := range files {
-		DEBUG.Println(STR, "file in All():", f.Name())
-		name := f.Name()
-		if len(name) < len(msgExt) || name[len(name)-len(msgExt):] != msgExt {
-			DEBUG.Println(STR, "skipping file, doesn't have right extension: ", name)
-			continue
-		}
-		key := name[0 : len(name)-4] // remove file extension
-		keys = append(keys, key)
-	}
-	return keys
-}
-
-// lockless
-func (store *FileStore) del(key string) {
-	if !store.opened {
-		ERROR.Println(STR, "trying to use file store, but not open")
-		return
-	}
-	DEBUG.Println(STR, "store del filepath:", store.directory)
-	DEBUG.Println(STR, "store delete key:", key)
-	filepath := fullpath(store.directory, key)
-	DEBUG.Println(STR, "path of deletion:", filepath)
-	if !exists(filepath) {
-		WARN.Println(STR, "store could not delete key:", key)
-		return
-	}
-	rerr := os.Remove(filepath)
-	chkerr(rerr)
-	DEBUG.Println(STR, "del msg:", key)
-	if exists(filepath) {
-		ERROR.Println(STR, "file not deleted:", filepath)
-	}
-}
-
-func fullpath(store string, key string) string {
-	p := path.Join(store, key+msgExt)
-	return p
-}
-
-func tmppath(store string, key string) string {
-	p := path.Join(store, key+tmpExt)
-	return p
-}
-
-func corruptpath(store string, key string) string {
-	p := path.Join(store, key+corruptExt)
-	return p
-}
-
-// create file called "X.[messageid].tmp" located in the store
-// the contents of the file is the bytes of the message, then
-// rename it to "X.[messageid].msg", overwriting any existing
-// message with the same id
-// X will be 'i' for inbound messages, and O for outbound messages
-func write(store, key string, m packets.ControlPacket) {
-	temppath := tmppath(store, key)
-	f, err := os.Create(temppath)
-	chkerr(err)
-	werr := m.Write(f)
-	chkerr(werr)
-	cerr := f.Close()
-	chkerr(cerr)
-	rerr := os.Rename(temppath, fullpath(store, key))
-	chkerr(rerr)
-}
-
-func exists(file string) bool {
-	if _, err := os.Stat(file); err != nil {
-		if os.IsNotExist(err) {
-			return false
-		}
-		chkerr(err)
-	}
-	return true
-}
-
-type fileInfos []fs.FileInfo
-
-func (f fileInfos) Len() int {
-	return len(f)
-}
-
-func (f fileInfos) Swap(i, j int) {
-	f[i], f[j] = f[j], f[i]
-}
-
-func (f fileInfos) Less(i, j int) bool {
-	return f[i].ModTime().Before(f[j].ModTime())
-}

vendor/github.com/eclipse/paho.mqtt.golang/memstore.go

@@ -1,142 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- */
-
-package mqtt
-
-import (
-	"sync"
-
-	"github.com/eclipse/paho.mqtt.golang/packets"
-)
-
-// MemoryStore implements the store interface to provide a "persistence"
-// mechanism wholly stored in memory. This is only useful for
-// as long as the client instance exists.
-type MemoryStore struct {
-	sync.RWMutex
-	messages map[string]packets.ControlPacket
-	opened   bool
-}
-
-// NewMemoryStore returns a pointer to a new instance of
-// MemoryStore, the instance is not initialized and ready to
-// use until Open() has been called on it.
-func NewMemoryStore() *MemoryStore {
-	store := &MemoryStore{
-		messages: make(map[string]packets.ControlPacket),
-		opened:   false,
-	}
-	return store
-}
-
-// Open initializes a MemoryStore instance.
-func (store *MemoryStore) Open() {
-	store.Lock()
-	defer store.Unlock()
-	store.opened = true
-	DEBUG.Println(STR, "memorystore initialized")
-}
-
-// Put takes a key and a pointer to a Message and stores the
-// message.
-func (store *MemoryStore) Put(key string, message packets.ControlPacket) {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use memory store, but not open")
-		return
-	}
-	store.messages[key] = message
-}
-
-// Get takes a key and looks in the store for a matching Message
-// returning either the Message pointer or nil.
-func (store *MemoryStore) Get(key string) packets.ControlPacket {
-	store.RLock()
-	defer store.RUnlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use memory store, but not open")
-		return nil
-	}
-	mid := mIDFromKey(key)
-	m := store.messages[key]
-	if m == nil {
-		CRITICAL.Println(STR, "memorystore get: message", mid, "not found")
-	} else {
-		DEBUG.Println(STR, "memorystore get: message", mid, "found")
-	}
-	return m
-}
-
-// All returns a slice of strings containing all the keys currently
-// in the MemoryStore.
-func (store *MemoryStore) All() []string {
-	store.RLock()
-	defer store.RUnlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use memory store, but not open")
-		return nil
-	}
-	var keys []string
-	for k := range store.messages {
-		keys = append(keys, k)
-	}
-	return keys
-}
-
-// Del takes a key, searches the MemoryStore and if the key is found
-// deletes the Message pointer associated with it.
-func (store *MemoryStore) Del(key string) {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use memory store, but not open")
-		return
-	}
-	mid := mIDFromKey(key)
-	m := store.messages[key]
-	if m == nil {
-		WARN.Println(STR, "memorystore del: message", mid, "not found")
-	} else {
-		delete(store.messages, key)
-		DEBUG.Println(STR, "memorystore del: message", mid, "was deleted")
-	}
-}
-
-// Close will disallow modifications to the state of the store.
-func (store *MemoryStore) Close() {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to close memory store, but not open")
-		return
-	}
-	store.opened = false
-	DEBUG.Println(STR, "memorystore closed")
-}
-
-// Reset eliminates all persisted message data in the store.
-func (store *MemoryStore) Reset() {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to reset memory store, but not open")
-	}
-	store.messages = make(map[string]packets.ControlPacket)
-	WARN.Println(STR, "memorystore wiped")
-}

vendor/github.com/eclipse/paho.mqtt.golang/memstore_ordered.go

@@ -1,166 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- *    Matt Brittan
- */
-
-package mqtt
-
-import (
-	"sort"
-	"sync"
-	"time"
-
-	"github.com/eclipse/paho.mqtt.golang/packets"
-)
-
-// OrderedMemoryStore uses a map internally so the order in which All() returns packets is
-// undefined. OrderedMemoryStore resolves this by storing the time the message is added
-// and sorting based upon this.
-
-// storedMessage encapsulates a message and the time it was initially stored
-type storedMessage struct {
-	ts  time.Time
-	msg packets.ControlPacket
-}
-
-// OrderedMemoryStore implements the store interface to provide a "persistence"
-// mechanism wholly stored in memory. This is only useful for
-// as long as the client instance exists.
-type OrderedMemoryStore struct {
-	sync.RWMutex
-	messages map[string]storedMessage
-	opened   bool
-}
-
-// NewOrderedMemoryStore returns a pointer to a new instance of
-// OrderedMemoryStore, the instance is not initialized and ready to
-// use until Open() has been called on it.
-func NewOrderedMemoryStore() *OrderedMemoryStore {
-	store := &OrderedMemoryStore{
-		messages: make(map[string]storedMessage),
-		opened:   false,
-	}
-	return store
-}
-
-// Open initializes a OrderedMemoryStore instance.
-func (store *OrderedMemoryStore) Open() {
-	store.Lock()
-	defer store.Unlock()
-	store.opened = true
-	DEBUG.Println(STR, "OrderedMemoryStore initialized")
-}
-
-// Put takes a key and a pointer to a Message and stores the
-// message.
-func (store *OrderedMemoryStore) Put(key string, message packets.ControlPacket) {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use memory store, but not open")
-		return
-	}
-	store.messages[key] = storedMessage{ts: time.Now(), msg: message}
-}
-
-// Get takes a key and looks in the store for a matching Message
-// returning either the Message pointer or nil.
-func (store *OrderedMemoryStore) Get(key string) packets.ControlPacket {
-	store.RLock()
-	defer store.RUnlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use memory store, but not open")
-		return nil
-	}
-	mid := mIDFromKey(key)
-	m, ok := store.messages[key]
-	if !ok || m.msg == nil {
-		CRITICAL.Println(STR, "OrderedMemoryStore get: message", mid, "not found")
-	} else {
-		DEBUG.Println(STR, "OrderedMemoryStore get: message", mid, "found")
-	}
-	return m.msg
-}
-
-// All returns a slice of strings containing all the keys currently
-// in the OrderedMemoryStore.
-func (store *OrderedMemoryStore) All() []string {
-	store.RLock()
-	defer store.RUnlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use memory store, but not open")
-		return nil
-	}
-	type tsAndKey struct {
-		ts  time.Time
-		key string
-	}
-
-	tsKeys := make([]tsAndKey, 0, len(store.messages))
-	for k, v := range store.messages {
-		tsKeys = append(tsKeys, tsAndKey{ts: v.ts, key: k})
-	}
-	sort.Slice(tsKeys, func(a int, b int) bool { return tsKeys[a].ts.Before(tsKeys[b].ts) })
-
-	keys := make([]string, len(tsKeys))
-	for i := range tsKeys {
-		keys[i] = tsKeys[i].key
-	}
-	return keys
-}
-
-// Del takes a key, searches the OrderedMemoryStore and if the key is found
-// deletes the Message pointer associated with it.
-func (store *OrderedMemoryStore) Del(key string) {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to use memory store, but not open")
-		return
-	}
-	mid := mIDFromKey(key)
-	_, ok := store.messages[key]
-	if !ok {
-		WARN.Println(STR, "OrderedMemoryStore del: message", mid, "not found")
-	} else {
-		delete(store.messages, key)
-		DEBUG.Println(STR, "OrderedMemoryStore del: message", mid, "was deleted")
-	}
-}
-
-// Close will disallow modifications to the state of the store.
-func (store *OrderedMemoryStore) Close() {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to close memory store, but not open")
-		return
-	}
-	store.opened = false
-	DEBUG.Println(STR, "OrderedMemoryStore closed")
-}
-
-// Reset eliminates all persisted message data in the store.
-func (store *OrderedMemoryStore) Reset() {
-	store.Lock()
-	defer store.Unlock()
-	if !store.opened {
-		ERROR.Println(STR, "Trying to reset memory store, but not open")
-	}
-	store.messages = make(map[string]storedMessage)
-	WARN.Println(STR, "OrderedMemoryStore wiped")
-}

vendor/github.com/eclipse/paho.mqtt.golang/message.go

@@ -1,131 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- */
-
-package mqtt
-
-import (
-	"net/url"
-	"sync"
-
-	"github.com/eclipse/paho.mqtt.golang/packets"
-)
-
-// Message defines the externals that a message implementation must support
-// these are received messages that are passed to the callbacks, not internal
-// messages
-type Message interface {
-	Duplicate() bool
-	Qos() byte
-	Retained() bool
-	Topic() string
-	MessageID() uint16
-	Payload() []byte
-	Ack()
-}
-
-type message struct {
-	duplicate bool
-	qos       byte
-	retained  bool
-	topic     string
-	messageID uint16
-	payload   []byte
-	once      sync.Once
-	ack       func()
-}
-
-func (m *message) Duplicate() bool {
-	return m.duplicate
-}
-
-func (m *message) Qos() byte {
-	return m.qos
-}
-
-func (m *message) Retained() bool {
-	return m.retained
-}
-
-func (m *message) Topic() string {
-	return m.topic
-}
-
-func (m *message) MessageID() uint16 {
-	return m.messageID
-}
-
-func (m *message) Payload() []byte {
-	return m.payload
-}
-
-func (m *message) Ack() {
-	m.once.Do(m.ack)
-}
-
-func messageFromPublish(p *packets.PublishPacket, ack func()) Message {
-	return &message{
-		duplicate: p.Dup,
-		qos:       p.Qos,
-		retained:  p.Retain,
-		topic:     p.TopicName,
-		messageID: p.MessageID,
-		payload:   p.Payload,
-		ack:       ack,
-	}
-}
-
-func newConnectMsgFromOptions(options *ClientOptions, broker *url.URL) *packets.ConnectPacket {
-	m := packets.NewControlPacket(packets.Connect).(*packets.ConnectPacket)
-
-	m.CleanSession = options.CleanSession
-	m.WillFlag = options.WillEnabled
-	m.WillRetain = options.WillRetained
-	m.ClientIdentifier = options.ClientID
-
-	if options.WillEnabled {
-		m.WillQos = options.WillQos
-		m.WillTopic = options.WillTopic
-		m.WillMessage = options.WillPayload
-	}
-
-	username := options.Username
-	password := options.Password
-	if broker.User != nil {
-		username = broker.User.Username()
-		if pwd, ok := broker.User.Password(); ok {
-			password = pwd
-		}
-	}
-	if options.CredentialsProvider != nil {
-		username, password = options.CredentialsProvider()
-	}
-
-	if username != "" {
-		m.UsernameFlag = true
-		m.Username = username
-		// mustn't have password without user as well
-		if password != "" {
-			m.PasswordFlag = true
-			m.Password = []byte(password)
-		}
-	}
-
-	m.Keepalive = uint16(options.KeepAlive)
-
-	return m
-}

vendor/github.com/eclipse/paho.mqtt.golang/messageids.go

@@ -1,200 +0,0 @@
-/*
- * Copyright (c) 2013 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- *    Matt Brittan
- */
-
-package mqtt
-
-import (
-	"fmt"
-	"sync"
-	"time"
-)
-
-// MId is 16 bit message id as specified by the MQTT spec.
-// In general, these values should not be depended upon by
-// the client application.
-type MId uint16
-
-type messageIds struct {
-	mu    sync.RWMutex // Named to prevent Mu from being accessible directly via client
-	index map[uint16]tokenCompletor
-
-	lastIssuedID uint16 // The most recently issued ID. Used so we cycle through ids rather than immediately reusing them (can make debugging easier)
-}
-
-const (
-	midMin uint16 = 1
-	midMax uint16 = 65535
-)
-
-// cleanup clears the message ID map; completes all token types and sets error on PUB, SUB and UNSUB tokens.
-func (mids *messageIds) cleanUp() {
-	mids.mu.Lock()
-	for _, token := range mids.index {
-		switch token.(type) {
-		case *PublishToken:
-			token.setError(fmt.Errorf("connection lost before Publish completed"))
-		case *SubscribeToken:
-			token.setError(fmt.Errorf("connection lost before Subscribe completed"))
-		case *UnsubscribeToken:
-			token.setError(fmt.Errorf("connection lost before Unsubscribe completed"))
-		case nil: // should not be any nil entries
-			continue
-		}
-		token.flowComplete()
-	}
-	mids.index = make(map[uint16]tokenCompletor)
-	mids.mu.Unlock()
-	DEBUG.Println(MID, "cleaned up")
-}
-
-// cleanUpSubscribe removes all SUBSCRIBE and UNSUBSCRIBE tokens (setting error)
-// This may be called when the connection is lost, and we will not be resending SUB/UNSUB packets
-func (mids *messageIds) cleanUpSubscribe() {
-	mids.mu.Lock()
-	for mid, token := range mids.index {
-		switch token.(type) {
-		case *SubscribeToken:
-			token.setError(fmt.Errorf("connection lost before Subscribe completed"))
-			delete(mids.index, mid)
-		case *UnsubscribeToken:
-			token.setError(fmt.Errorf("connection lost before Unsubscribe completed"))
-			delete(mids.index, mid)
-		}
-	}
-	mids.mu.Unlock()
-	DEBUG.Println(MID, "cleaned up subs")
-}
-
-func (mids *messageIds) freeID(id uint16) {
-	mids.mu.Lock()
-	delete(mids.index, id)
-	mids.mu.Unlock()
-}
-
-func (mids *messageIds) claimID(token tokenCompletor, id uint16) {
-	mids.mu.Lock()
-	defer mids.mu.Unlock()
-	if _, ok := mids.index[id]; !ok {
-		mids.index[id] = token
-	} else {
-		old := mids.index[id]
-		old.flowComplete()
-		mids.index[id] = token
-	}
-	if id > mids.lastIssuedID {
-		mids.lastIssuedID = id
-	}
-}
-
-// getID will return an available id or 0 if none available
-// The id will generally be the previous id + 1 (because this makes tracing messages a bit simpler)
-func (mids *messageIds) getID(t tokenCompletor) uint16 {
-	mids.mu.Lock()
-	defer mids.mu.Unlock()
-	i := mids.lastIssuedID // note: the only situation where lastIssuedID is 0 the map will be empty
-	looped := false        // uint16 will loop from 65535->0
-	for {
-		i++
-		if i == 0 { // skip 0 because its not a valid id (Control Packets MUST contain a non-zero 16-bit Packet Identifier [MQTT-2.3.1-1])
-			i++
-			looped = true
-		}
-		if _, ok := mids.index[i]; !ok {
-			mids.index[i] = t
-			mids.lastIssuedID = i
-			return i
-		}
-		if (looped && i == mids.lastIssuedID) || (mids.lastIssuedID == 0 && i == midMax) { // lastIssuedID will be 0 at startup
-			return 0 // no free ids
-		}
-	}
-}
-
-func (mids *messageIds) getToken(id uint16) tokenCompletor {
-	mids.mu.RLock()
-	defer mids.mu.RUnlock()
-	if token, ok := mids.index[id]; ok {
-		return token
-	}
-	return &DummyToken{id: id}
-}
-
-type DummyToken struct {
-	id uint16
-}
-
-// Wait implements the Token Wait method.
-func (d *DummyToken) Wait() bool {
-	return true
-}
-
-// WaitTimeout implements the Token WaitTimeout method.
-func (d *DummyToken) WaitTimeout(t time.Duration) bool {
-	return true
-}
-
-// Done implements the Token Done method.
-func (d *DummyToken) Done() <-chan struct{} {
-	ch := make(chan struct{})
-	close(ch)
-	return ch
-}
-
-func (d *DummyToken) flowComplete() {
-	ERROR.Printf("A lookup for token %d returned nil\n", d.id)
-}
-
-func (d *DummyToken) Error() error {
-	return nil
-}
-
-func (d *DummyToken) setError(e error) {}
-
-// PlaceHolderToken does nothing and was implemented to allow a messageid to be reserved
-// it differs from DummyToken in that calling flowComplete does not generate an error (it
-// is expected that flowComplete will be called when the token is overwritten with a real token)
-type PlaceHolderToken struct {
-	id uint16
-}
-
-// Wait implements the Token Wait method.
-func (p *PlaceHolderToken) Wait() bool {
-	return true
-}
-
-// WaitTimeout implements the Token WaitTimeout method.
-func (p *PlaceHolderToken) WaitTimeout(t time.Duration) bool {
-	return true
-}
-
-// Done implements the Token Done method.
-func (p *PlaceHolderToken) Done() <-chan struct{} {
-	ch := make(chan struct{})
-	close(ch)
-	return ch
-}
-
-func (p *PlaceHolderToken) flowComplete() {
-}
-
-func (p *PlaceHolderToken) Error() error {
-	return nil
-}
-
-func (p *PlaceHolderToken) setError(e error) {}

vendor/github.com/eclipse/paho.mqtt.golang/net.go

@@ -1,469 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- *    Matt Brittan
- */
-
-package mqtt
-
-import (
-	"errors"
-	"io"
-	"net"
-	"reflect"
-	"strings"
-	"sync"
-	"time"
-
-	"github.com/eclipse/paho.mqtt.golang/packets"
-)
-
-const closedNetConnErrorText = "use of closed network connection" // error string for closed conn (https://golang.org/src/net/error_test.go)
-
-// ConnectMQTT takes a connected net.Conn and performs the initial MQTT handshake. Parameters are:
-// conn - Connected net.Conn
-// cm - Connect Packet with everything other than the protocol name/version populated (historical reasons)
-// protocolVersion - The protocol version to attempt to connect with
-//
-// Note that, for backward compatibility, ConnectMQTT() suppresses the actual connection error (compare to connectMQTT()).
-func ConnectMQTT(conn net.Conn, cm *packets.ConnectPacket, protocolVersion uint) (byte, bool) {
-	rc, sessionPresent, _ := connectMQTT(conn, cm, protocolVersion)
-	return rc, sessionPresent
-}
-
-func connectMQTT(conn io.ReadWriter, cm *packets.ConnectPacket, protocolVersion uint) (byte, bool, error) {
-	switch protocolVersion {
-	case 3:
-		DEBUG.Println(CLI, "Using MQTT 3.1 protocol")
-		cm.ProtocolName = "MQIsdp"
-		cm.ProtocolVersion = 3
-	case 0x83:
-		DEBUG.Println(CLI, "Using MQTT 3.1b protocol")
-		cm.ProtocolName = "MQIsdp"
-		cm.ProtocolVersion = 0x83
-	case 0x84:
-		DEBUG.Println(CLI, "Using MQTT 3.1.1b protocol")
-		cm.ProtocolName = "MQTT"
-		cm.ProtocolVersion = 0x84
-	default:
-		DEBUG.Println(CLI, "Using MQTT 3.1.1 protocol")
-		cm.ProtocolName = "MQTT"
-		cm.ProtocolVersion = 4
-	}
-
-	if err := cm.Write(conn); err != nil {
-		ERROR.Println(CLI, err)
-		return packets.ErrNetworkError, false, err
-	}
-
-	rc, sessionPresent, err := verifyCONNACK(conn)
-	return rc, sessionPresent, err
-}
-
-// This function is only used for receiving a connack
-// when the connection is first started.
-// This prevents receiving incoming data while resume
-// is in progress if clean session is false.
-func verifyCONNACK(conn io.Reader) (byte, bool, error) {
-	DEBUG.Println(NET, "connect started")
-
-	ca, err := packets.ReadPacket(conn)
-	if err != nil {
-		ERROR.Println(NET, "connect got error", err)
-		return packets.ErrNetworkError, false, err
-	}
-
-	if ca == nil {
-		ERROR.Println(NET, "received nil packet")
-		return packets.ErrNetworkError, false, errors.New("nil CONNACK packet")
-	}
-
-	msg, ok := ca.(*packets.ConnackPacket)
-	if !ok {
-		ERROR.Println(NET, "received msg that was not CONNACK")
-		return packets.ErrNetworkError, false, errors.New("non-CONNACK first packet received")
-	}
-
-	DEBUG.Println(NET, "received connack")
-	return msg.ReturnCode, msg.SessionPresent, nil
-}
-
-// inbound encapsulates the output from startIncoming.
-// err  - If != nil then an error has occurred
-// cp - A control packet received over the network link
-type inbound struct {
-	err error
-	cp  packets.ControlPacket
-}
-
-// startIncoming initiates a goroutine that reads incoming messages off the wire and sends them to the channel (returned).
-// If there are any issues with the network connection then the returned channel will be closed and the goroutine will exit
-// (so closing the connection will terminate the goroutine)
-func startIncoming(conn io.Reader) <-chan inbound {
-	var err error
-	var cp packets.ControlPacket
-	ibound := make(chan inbound)
-
-	DEBUG.Println(NET, "incoming started")
-
-	go func() {
-		for {
-			if cp, err = packets.ReadPacket(conn); err != nil {
-				// We do not want to log the error if it is due to the network connection having been closed
-				// elsewhere (i.e. after sending DisconnectPacket). Detecting this situation is the subject of
-				// https://github.com/golang/go/issues/4373
-				if !strings.Contains(err.Error(), closedNetConnErrorText) {
-					ibound <- inbound{err: err}
-				}
-				close(ibound)
-				DEBUG.Println(NET, "incoming complete")
-				return
-			}
-			DEBUG.Println(NET, "startIncoming Received Message")
-			ibound <- inbound{cp: cp}
-		}
-	}()
-
-	return ibound
-}
-
-// incomingComms encapsulates the possible output of the incomingComms routine. If err != nil then an error has occurred and
-// the routine will have terminated; otherwise one of the other members should be non-nil
-type incomingComms struct {
-	err         error                  // If non-nil then there has been an error (ignore everything else)
-	outbound    *PacketAndToken        // Packet (with token) than needs to be sent out (e.g. an acknowledgement)
-	incomingPub *packets.PublishPacket // A new publish has been received; this will need to be passed on to our user
-}
-
-// startIncomingComms initiates incoming communications; this includes starting a goroutine to process incoming
-// messages.
-// Accepts a channel of inbound messages from the store (persisted messages); note this must be closed as soon as
-// everything in the store has been sent.
-// Returns a channel that will be passed any received packets; this will be closed on a network error (and inboundFromStore closed)
-func startIncomingComms(conn io.Reader,
-	c commsFns,
-	inboundFromStore <-chan packets.ControlPacket,
-) <-chan incomingComms {
-	ibound := startIncoming(conn) // Start goroutine that reads from network connection
-	output := make(chan incomingComms)
-
-	DEBUG.Println(NET, "startIncomingComms started")
-	go func() {
-		for {
-			if inboundFromStore == nil && ibound == nil {
-				close(output)
-				DEBUG.Println(NET, "startIncomingComms goroutine complete")
-				return // As soon as ibound is closed we can exit (should have already processed an error)
-			}
-			DEBUG.Println(NET, "logic waiting for msg on ibound")
-
-			var msg packets.ControlPacket
-			var ok bool
-			select {
-			case msg, ok = <-inboundFromStore:
-				if !ok {
-					DEBUG.Println(NET, "startIncomingComms: inboundFromStore complete")
-					inboundFromStore = nil // should happen quickly as this is only for persisted messages
-					continue
-				}
-				DEBUG.Println(NET, "startIncomingComms: got msg from store")
-			case ibMsg, ok := <-ibound:
-				if !ok {
-					DEBUG.Println(NET, "startIncomingComms: ibound complete")
-					ibound = nil
-					continue
-				}
-				DEBUG.Println(NET, "startIncomingComms: got msg on ibound")
-				// If the inbound comms routine encounters any issues it will send us an error.
-				if ibMsg.err != nil {
-					output <- incomingComms{err: ibMsg.err}
-					continue // Usually the channel will be closed immediately after sending an error but safer that we do not assume this
-				}
-				msg = ibMsg.cp
-
-				c.persistInbound(msg)
-				c.UpdateLastReceived() // Notify keepalive logic that we recently received a packet
-			}
-
-			switch m := msg.(type) {
-			case *packets.PingrespPacket:
-				DEBUG.Println(NET, "startIncomingComms: received pingresp")
-				c.pingRespReceived()
-			case *packets.SubackPacket:
-				DEBUG.Println(NET, "startIncomingComms: received suback, id:", m.MessageID)
-				token := c.getToken(m.MessageID)
-
-				if t, ok := token.(*SubscribeToken); ok {
-					DEBUG.Println(NET, "startIncomingComms: granted qoss", m.ReturnCodes)
-					for i, qos := range m.ReturnCodes {
-						t.subResult[t.subs[i]] = qos
-					}
-				}
-
-				token.flowComplete()
-				c.freeID(m.MessageID)
-			case *packets.UnsubackPacket:
-				DEBUG.Println(NET, "startIncomingComms: received unsuback, id:", m.MessageID)
-				c.getToken(m.MessageID).flowComplete()
-				c.freeID(m.MessageID)
-			case *packets.PublishPacket:
-				DEBUG.Println(NET, "startIncomingComms: received publish, msgId:", m.MessageID)
-				output <- incomingComms{incomingPub: m}
-			case *packets.PubackPacket:
-				DEBUG.Println(NET, "startIncomingComms: received puback, id:", m.MessageID)
-				c.getToken(m.MessageID).flowComplete()
-				c.freeID(m.MessageID)
-			case *packets.PubrecPacket:
-				DEBUG.Println(NET, "startIncomingComms: received pubrec, id:", m.MessageID)
-				prel := packets.NewControlPacket(packets.Pubrel).(*packets.PubrelPacket)
-				prel.MessageID = m.MessageID
-				output <- incomingComms{outbound: &PacketAndToken{p: prel, t: nil}}
-			case *packets.PubrelPacket:
-				DEBUG.Println(NET, "startIncomingComms: received pubrel, id:", m.MessageID)
-				pc := packets.NewControlPacket(packets.Pubcomp).(*packets.PubcompPacket)
-				pc.MessageID = m.MessageID
-				c.persistOutbound(pc)
-				output <- incomingComms{outbound: &PacketAndToken{p: pc, t: nil}}
-			case *packets.PubcompPacket:
-				DEBUG.Println(NET, "startIncomingComms: received pubcomp, id:", m.MessageID)
-				c.getToken(m.MessageID).flowComplete()
-				c.freeID(m.MessageID)
-			}
-		}
-	}()
-	return output
-}
-
-// startOutgoingComms initiates a go routine to transmit outgoing packets.
-// Pass in an open network connection and channels for outbound messages (including those triggered
-// directly from incoming comms).
-// Returns a channel that will receive details of any errors (closed when the goroutine exits)
-// This function wil only terminate when all input channels are closed
-func startOutgoingComms(conn net.Conn,
-	c commsFns,
-	oboundp <-chan *PacketAndToken,
-	obound <-chan *PacketAndToken,
-	oboundFromIncoming <-chan *PacketAndToken,
-) <-chan error {
-	errChan := make(chan error)
-	DEBUG.Println(NET, "outgoing started")
-
-	go func() {
-		for {
-			DEBUG.Println(NET, "outgoing waiting for an outbound message")
-
-			// This goroutine will only exits when all of the input channels we receive on have been closed. This approach is taken to avoid any
-			// deadlocks (if the connection goes down there are limited options as to what we can do with anything waiting on us and
-			// throwing away the packets seems the best option)
-			if oboundp == nil && obound == nil && oboundFromIncoming == nil {
-				DEBUG.Println(NET, "outgoing comms stopping")
-				close(errChan)
-				return
-			}
-
-			select {
-			case pub, ok := <-obound:
-				if !ok {
-					obound = nil
-					continue
-				}
-				msg := pub.p.(*packets.PublishPacket)
-				DEBUG.Println(NET, "obound msg to write", msg.MessageID)
-
-				writeTimeout := c.getWriteTimeOut()
-				if writeTimeout > 0 {
-					if err := conn.SetWriteDeadline(time.Now().Add(writeTimeout)); err != nil {
-						ERROR.Println(NET, "SetWriteDeadline ", err)
-					}
-				}
-
-				if err := msg.Write(conn); err != nil {
-					ERROR.Println(NET, "outgoing obound reporting error ", err)
-					pub.t.setError(err)
-					// report error if it's not due to the connection being closed elsewhere
-					if !strings.Contains(err.Error(), closedNetConnErrorText) {
-						errChan <- err
-					}
-					continue
-				}
-
-				if writeTimeout > 0 {
-					// If we successfully wrote, we don't want the timeout to happen during an idle period
-					// so we reset it to infinite.
-					if err := conn.SetWriteDeadline(time.Time{}); err != nil {
-						ERROR.Println(NET, "SetWriteDeadline to 0 ", err)
-					}
-				}
-
-				if msg.Qos == 0 {
-					pub.t.flowComplete()
-				}
-				DEBUG.Println(NET, "obound wrote msg, id:", msg.MessageID)
-			case msg, ok := <-oboundp:
-				if !ok {
-					oboundp = nil
-					continue
-				}
-				DEBUG.Println(NET, "obound priority msg to write, type", reflect.TypeOf(msg.p))
-				if err := msg.p.Write(conn); err != nil {
-					ERROR.Println(NET, "outgoing oboundp reporting error ", err)
-					if msg.t != nil {
-						msg.t.setError(err)
-					}
-					errChan <- err
-					continue
-				}
-
-				if _, ok := msg.p.(*packets.DisconnectPacket); ok {
-					msg.t.(*DisconnectToken).flowComplete()
-					DEBUG.Println(NET, "outbound wrote disconnect, closing connection")
-					// As per the MQTT spec "After sending a DISCONNECT Packet the Client MUST close the Network Connection"
-					// Closing the connection will cause the goroutines to end in sequence (starting with incoming comms)
-					_ = conn.Close()
-				}
-			case msg, ok := <-oboundFromIncoming: // message triggered by an inbound message (PubrecPacket or PubrelPacket)
-				if !ok {
-					oboundFromIncoming = nil
-					continue
-				}
-				DEBUG.Println(NET, "obound from incoming msg to write, type", reflect.TypeOf(msg.p), " ID ", msg.p.Details().MessageID)
-				if err := msg.p.Write(conn); err != nil {
-					ERROR.Println(NET, "outgoing oboundFromIncoming reporting error", err)
-					if msg.t != nil {
-						msg.t.setError(err)
-					}
-					errChan <- err
-					continue
-				}
-			}
-			c.UpdateLastSent() // Record that a packet has been received (for keepalive routine)
-		}
-	}()
-	return errChan
-}
-
-// commsFns provide access to the client state (messageids, requesting disconnection and updating timing)
-type commsFns interface {
-	getToken(id uint16) tokenCompletor       // Retrieve the token for the specified messageid (if none then a dummy token must be returned)
-	freeID(id uint16)                        // Release the specified messageid (clearing out of any persistent store)
-	UpdateLastReceived()                     // Must be called whenever a packet is received
-	UpdateLastSent()                         // Must be called whenever a packet is successfully sent
-	getWriteTimeOut() time.Duration          // Return the writetimeout (or 0 if none)
-	persistOutbound(m packets.ControlPacket) // add the packet to the outbound store
-	persistInbound(m packets.ControlPacket)  // add the packet to the inbound store
-	pingRespReceived()                       // Called when a ping response is received
-}
-
-// startComms initiates goroutines that handles communications over the network connection
-// Messages will be stored (via commsFns) and deleted from the store as necessary
-// It returns two channels:
-//
-//	packets.PublishPacket - Will receive publish packets received over the network.
-//	Closed when incoming comms routines exit (on shutdown or if network link closed)
-//	error - Any errors will be sent on this channel. The channel is closed when all comms routines have shut down
-//
-// Note: The comms routines monitoring oboundp and obound will not shutdown until those channels are both closed. Any messages received between the
-// connection being closed and those channels being closed will generate errors (and nothing will be sent). That way the chance of a deadlock is
-// minimised.
-func startComms(conn net.Conn, // Network connection (must be active)
-	c commsFns, // getters and setters to enable us to cleanly interact with client
-	inboundFromStore <-chan packets.ControlPacket, // Inbound packets from the persistence store (should be closed relatively soon after startup)
-	oboundp <-chan *PacketAndToken,
-	obound <-chan *PacketAndToken) (
-	<-chan *packets.PublishPacket, // Publishpackages received over the network
-	<-chan error, // Any errors (should generally trigger a disconnect)
-) {
-	// Start inbound comms handler; this needs to be able to transmit messages so we start a go routine to add these to the priority outbound channel
-	ibound := startIncomingComms(conn, c, inboundFromStore)
-	outboundFromIncoming := make(chan *PacketAndToken) // Will accept outgoing messages triggered by startIncomingComms (e.g. acknowledgements)
-
-	// Start the outgoing handler. It is important to note that output from startIncomingComms is fed into startOutgoingComms (for ACK's)
-	oboundErr := startOutgoingComms(conn, c, oboundp, obound, outboundFromIncoming)
-	DEBUG.Println(NET, "startComms started")
-
-	// Run up go routines to handle the output from the above comms functions - these are handled in separate
-	// go routines because they can interact (e.g. ibound triggers an ACK to obound which triggers an error)
-	var wg sync.WaitGroup
-	wg.Add(2)
-
-	outPublish := make(chan *packets.PublishPacket)
-	outError := make(chan error)
-
-	// Any messages received get passed to the appropriate channel
-	go func() {
-		for ic := range ibound {
-			if ic.err != nil {
-				outError <- ic.err
-				continue
-			}
-			if ic.outbound != nil {
-				outboundFromIncoming <- ic.outbound
-				continue
-			}
-			if ic.incomingPub != nil {
-				outPublish <- ic.incomingPub
-				continue
-			}
-			ERROR.Println(STR, "startComms received empty incomingComms msg")
-		}
-		// Close channels that will not be written to again (allowing other routines to exit)
-		close(outboundFromIncoming)
-		close(outPublish)
-		wg.Done()
-	}()
-
-	// Any errors will be passed out to our caller
-	go func() {
-		for err := range oboundErr {
-			outError <- err
-		}
-		wg.Done()
-	}()
-
-	// outError is used by both routines so can only be closed when they are both complete
-	go func() {
-		wg.Wait()
-		close(outError)
-		DEBUG.Println(NET, "startComms closing outError")
-	}()
-
-	return outPublish, outError
-}
-
-// ackFunc acknowledges a packet
-// WARNING sendAck may be called at any time (even after the connection is dead). At the time of writing ACK sent after
-// connection loss will be dropped (this is not ideal)
-func ackFunc(sendAck func(*PacketAndToken), persist Store, packet *packets.PublishPacket) func() {
-	return func() {
-		switch packet.Qos {
-		case 2:
-			pr := packets.NewControlPacket(packets.Pubrec).(*packets.PubrecPacket)
-			pr.MessageID = packet.MessageID
-			DEBUG.Println(NET, "putting pubrec msg on obound")
-			sendAck(&PacketAndToken{p: pr, t: nil})
-			DEBUG.Println(NET, "done putting pubrec msg on obound")
-		case 1:
-			pa := packets.NewControlPacket(packets.Puback).(*packets.PubackPacket)
-			pa.MessageID = packet.MessageID
-			DEBUG.Println(NET, "putting puback msg on obound")
-			persistOutbound(persist, pa) // May fail if store has been closed
-			sendAck(&PacketAndToken{p: pa, t: nil})
-			DEBUG.Println(NET, "done putting puback msg on obound")
-		case 0:
-			// do nothing, since there is no need to send an ack packet back
-		}
-	}
-}

vendor/github.com/eclipse/paho.mqtt.golang/netconn.go

@@ -1,101 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- *    MAtt Brittan
- */
-
-package mqtt
-
-import (
-	"crypto/tls"
-	"errors"
-	"net"
-	"net/http"
-	"net/url"
-	"os"
-	"time"
-
-	"golang.org/x/net/proxy"
-)
-
-//
-// This just establishes the network connection; once established the type of connection should be irrelevant
-//
-
-// openConnection opens a network connection using the protocol indicated in the URL.
-// Does not carry out any MQTT specific handshakes.
-func openConnection(uri *url.URL, tlsc *tls.Config, timeout time.Duration, headers http.Header, websocketOptions *WebsocketOptions, dialer *net.Dialer) (net.Conn, error) {
-	switch uri.Scheme {
-	case "ws":
-		dialURI := *uri // #623 - Gorilla Websockets does not accept URL's where uri.User != nil
-		dialURI.User = nil
-		conn, err := NewWebsocket(dialURI.String(), nil, timeout, headers, websocketOptions)
-		return conn, err
-	case "wss":
-		dialURI := *uri // #623 - Gorilla Websockets does not accept URL's where uri.User != nil
-		dialURI.User = nil
-		conn, err := NewWebsocket(dialURI.String(), tlsc, timeout, headers, websocketOptions)
-		return conn, err
-	case "mqtt", "tcp":
-		proxyDialer := proxy.FromEnvironmentUsing(dialer)
-		conn, err := proxyDialer.Dial("tcp", uri.Host)
-		if err != nil {
-			return nil, err
-		}
-		return conn, nil
-	case "unix":
-		var conn net.Conn
-		var err error
-
-		// this check is preserved for compatibility with older versions
-		// which used uri.Host only (it works for local paths, e.g. unix://socket.sock in current dir)
-		if len(uri.Host) > 0 {
-			conn, err = dialer.Dial("unix", uri.Host)
-		} else {
-			conn, err = dialer.Dial("unix", uri.Path)
-		}
-
-		if err != nil {
-			return nil, err
-		}
-		return conn, nil
-	case "ssl", "tls", "mqtts", "mqtt+ssl", "tcps":
-		allProxy := os.Getenv("all_proxy")
-		if len(allProxy) == 0 {
-			conn, err := tls.DialWithDialer(dialer, "tcp", uri.Host, tlsc)
-			if err != nil {
-				return nil, err
-			}
-			return conn, nil
-		}
-		proxyDialer := proxy.FromEnvironment()
-		conn, err := proxyDialer.Dial("tcp", uri.Host)
-		if err != nil {
-			return nil, err
-		}
-
-		tlsConn := tls.Client(conn, tlsc)
-
-		err = tlsConn.Handshake()
-		if err != nil {
-			_ = conn.Close()
-			return nil, err
-		}
-
-		return tlsConn, nil
-	}
-	return nil, errors.New("unknown protocol")
-}

vendor/github.com/eclipse/paho.mqtt.golang/oops.go

@@ -1,25 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- */
-
-package mqtt
-
-func chkerr(e error) {
-	if e != nil {
-		panic(e)
-	}
-}

vendor/github.com/eclipse/paho.mqtt.golang/options.go

@@ -1,471 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- *    Måns Ansgariusson
- */
-
-// Portions copyright © 2018 TIBCO Software Inc.
-
-package mqtt
-
-import (
-	"crypto/tls"
-	"net"
-	"net/http"
-	"net/url"
-	"strings"
-	"time"
-)
-
-// CredentialsProvider allows the username and password to be updated
-// before reconnecting. It should return the current username and password.
-type CredentialsProvider func() (username string, password string)
-
-// MessageHandler is a callback type which can be set to be
-// executed upon the arrival of messages published to topics
-// to which the client is subscribed.
-type MessageHandler func(Client, Message)
-
-// ConnectionLostHandler is a callback type which can be set to be
-// executed upon an unintended disconnection from the MQTT broker.
-// Disconnects caused by calling Disconnect or ForceDisconnect will
-// not cause an OnConnectionLost callback to execute.
-type ConnectionLostHandler func(Client, error)
-
-// OnConnectHandler is a callback that is called when the client
-// state changes from unconnected/disconnected to connected. Both
-// at initial connection and on reconnection
-type OnConnectHandler func(Client)
-
-// ReconnectHandler is invoked prior to reconnecting after
-// the initial connection is lost
-type ReconnectHandler func(Client, *ClientOptions)
-
-// ConnectionAttemptHandler is invoked prior to making the initial connection.
-type ConnectionAttemptHandler func(broker *url.URL, tlsCfg *tls.Config) *tls.Config
-
-// OpenConnectionFunc is invoked to establish the underlying network connection
-// Its purpose if for custom network transports.
-// Does not carry out any MQTT specific handshakes.
-type OpenConnectionFunc func(uri *url.URL, options ClientOptions) (net.Conn, error)
-
-// ConnectionNotificationHandler is invoked for any type of connection event.
-type ConnectionNotificationHandler func(Client, ConnectionNotification)
-
-// ClientOptions contains configurable options for an Client. Note that these should be set using the
-// relevant methods (e.g. AddBroker) rather than directly. See those functions for information on usage.
-// WARNING: Create the below using NewClientOptions unless you have a compelling reason not to. It is easy
-// to create a configuration with difficult to trace issues (e.g. Mosquitto 2.0.12+ will reject connections
-// with KeepAlive=0 by default).
-type ClientOptions struct {
-	Servers                  []*url.URL
-	ClientID                 string
-	Username                 string
-	Password                 string
-	CredentialsProvider      CredentialsProvider
-	CleanSession             bool
-	Order                    bool
-	WillEnabled              bool
-	WillTopic                string
-	WillPayload              []byte
-	WillQos                  byte
-	WillRetained             bool
-	ProtocolVersion          uint
-	protocolVersionExplicit  bool
-	TLSConfig                *tls.Config
-	KeepAlive                int64 // Warning: Some brokers may reject connections with Keepalive = 0.
-	PingTimeout              time.Duration
-	ConnectTimeout           time.Duration
-	MaxReconnectInterval     time.Duration
-	AutoReconnect            bool
-	ConnectRetryInterval     time.Duration
-	ConnectRetry             bool
-	Store                    Store
-	DefaultPublishHandler    MessageHandler
-	OnConnect                OnConnectHandler
-	OnConnectionLost         ConnectionLostHandler
-	OnReconnecting           ReconnectHandler
-	OnConnectAttempt         ConnectionAttemptHandler
-	OnConnectionNotification ConnectionNotificationHandler
-	WriteTimeout             time.Duration
-	MessageChannelDepth      uint
-	ResumeSubs               bool
-	HTTPHeaders              http.Header
-	WebsocketOptions         *WebsocketOptions
-	MaxResumePubInFlight     int // // 0 = no limit; otherwise this is the maximum simultaneous messages sent while resuming
-	Dialer                   *net.Dialer
-	CustomOpenConnectionFn   OpenConnectionFunc
-	AutoAckDisabled          bool
-}
-
-// NewClientOptions will create a new ClientClientOptions type with some
-// default values.
-//
-//	Port: 1883
-//	CleanSession: True
-//	Order: True (note: it is recommended that this be set to FALSE unless order is important)
-//	KeepAlive: 30 (seconds)
-//	ConnectTimeout: 30 (seconds)
-//	MaxReconnectInterval 10 (minutes)
-//	AutoReconnect: True
-func NewClientOptions() *ClientOptions {
-	o := &ClientOptions{
-		Servers:                  nil,
-		ClientID:                 "",
-		Username:                 "",
-		Password:                 "",
-		CleanSession:             true,
-		Order:                    true,
-		WillEnabled:              false,
-		WillTopic:                "",
-		WillPayload:              nil,
-		WillQos:                  0,
-		WillRetained:             false,
-		ProtocolVersion:          0,
-		protocolVersionExplicit:  false,
-		KeepAlive:                30,
-		PingTimeout:              10 * time.Second,
-		ConnectTimeout:           30 * time.Second,
-		MaxReconnectInterval:     10 * time.Minute,
-		AutoReconnect:            true,
-		ConnectRetryInterval:     30 * time.Second,
-		ConnectRetry:             false,
-		Store:                    nil,
-		OnConnect:                nil,
-		OnConnectionLost:         DefaultConnectionLostHandler,
-		OnConnectAttempt:         nil,
-		OnConnectionNotification: nil,
-		WriteTimeout:             0, // 0 represents timeout disabled
-		ResumeSubs:               false,
-		HTTPHeaders:              make(map[string][]string),
-		WebsocketOptions:         &WebsocketOptions{},
-		Dialer:                   &net.Dialer{Timeout: 30 * time.Second},
-		CustomOpenConnectionFn:   nil,
-		AutoAckDisabled:          false,
-	}
-	return o
-}
-
-// AddBroker adds a broker URI to the list of brokers to be used. The format should be
-// scheme://host:port
-// Where "scheme" is one of "tcp", "ssl", or "ws", "host" is the ip-address (or hostname)
-// and "port" is the port on which the broker is accepting connections.
-//
-// Default values for hostname is "127.0.0.1", for schema is "tcp://".
-//
-// An example broker URI would look like: tcp://foobar.com:1883
-func (o *ClientOptions) AddBroker(server string) *ClientOptions {
-	if len(server) > 0 && server[0] == ':' {
-		server = "127.0.0.1" + server
-	}
-	if !strings.Contains(server, "://") {
-		server = "tcp://" + server
-	}
-	brokerURI, err := url.Parse(server)
-	if err != nil {
-		ERROR.Println(CLI, "Failed to parse %q broker address: %s", server, err)
-		return o
-	}
-	o.Servers = append(o.Servers, brokerURI)
-	return o
-}
-
-// SetResumeSubs will enable resuming of stored (un)subscribe messages when connecting
-// but not reconnecting if CleanSession is false. Otherwise these messages are discarded.
-func (o *ClientOptions) SetResumeSubs(resume bool) *ClientOptions {
-	o.ResumeSubs = resume
-	return o
-}
-
-// SetClientID will set the client id to be used by this client when
-// connecting to the MQTT broker. According to the MQTT v3.1 specification,
-// a client id must be no longer than 23 characters.
-func (o *ClientOptions) SetClientID(id string) *ClientOptions {
-	o.ClientID = id
-	return o
-}
-
-// SetUsername will set the username to be used by this client when connecting
-// to the MQTT broker. Note: without the use of SSL/TLS, this information will
-// be sent in plaintext across the wire.
-func (o *ClientOptions) SetUsername(u string) *ClientOptions {
-	o.Username = u
-	return o
-}
-
-// SetPassword will set the password to be used by this client when connecting
-// to the MQTT broker. Note: without the use of SSL/TLS, this information will
-// be sent in plaintext across the wire.
-func (o *ClientOptions) SetPassword(p string) *ClientOptions {
-	o.Password = p
-	return o
-}
-
-// SetCredentialsProvider will set a method to be called by this client when
-// connecting to the MQTT broker that provide the current username and password.
-// Note: without the use of SSL/TLS, this information will be sent
-// in plaintext across the wire.
-func (o *ClientOptions) SetCredentialsProvider(p CredentialsProvider) *ClientOptions {
-	o.CredentialsProvider = p
-	return o
-}
-
-// SetCleanSession will set the "clean session" flag in the connect message
-// when this client connects to an MQTT broker. By setting this flag, you are
-// indicating that no messages saved by the broker for this client should be
-// delivered. Any messages that were going to be sent by this client before
-// disconnecting previously but didn't will not be sent upon connecting to the
-// broker.
-func (o *ClientOptions) SetCleanSession(clean bool) *ClientOptions {
-	o.CleanSession = clean
-	return o
-}
-
-// SetOrderMatters will set the message routing to guarantee order within
-// each QoS level. By default, this value is true. If set to false (recommended),
-// this flag indicates that messages can be delivered asynchronously
-// from the client to the application and possibly arrive out of order.
-// Specifically, the message handler is called in its own go routine.
-// Note that setting this to true does not guarantee in-order delivery
-// (this is subject to broker settings like "max_inflight_messages=1" in mosquitto)
-// and if true then handlers must not block.
-func (o *ClientOptions) SetOrderMatters(order bool) *ClientOptions {
-	o.Order = order
-	return o
-}
-
-// SetTLSConfig will set an SSL/TLS configuration to be used when connecting
-// to an MQTT broker. Please read the official Go documentation for more
-// information.
-func (o *ClientOptions) SetTLSConfig(t *tls.Config) *ClientOptions {
-	o.TLSConfig = t
-	return o
-}
-
-// SetStore will set the implementation of the Store interface
-// used to provide message persistence in cases where QoS levels
-// QoS_ONE or QoS_TWO are used. If no store is provided, then the
-// client will use MemoryStore by default.
-func (o *ClientOptions) SetStore(s Store) *ClientOptions {
-	o.Store = s
-	return o
-}
-
-// SetKeepAlive will set the amount of time (in seconds) that the client
-// should wait before sending a PING request to the broker. This will
-// allow the client to know that a connection has not been lost with the
-// server.
-func (o *ClientOptions) SetKeepAlive(k time.Duration) *ClientOptions {
-	o.KeepAlive = int64(k / time.Second)
-	return o
-}
-
-// SetPingTimeout will set the amount of time (in seconds) that the client
-// will wait after sending a PING request to the broker, before deciding
-// that the connection has been lost. Default is 10 seconds.
-func (o *ClientOptions) SetPingTimeout(k time.Duration) *ClientOptions {
-	o.PingTimeout = k
-	return o
-}
-
-// SetProtocolVersion sets the MQTT version to be used to connect to the
-// broker. Legitimate values are currently 3 - MQTT 3.1 or 4 - MQTT 3.1.1
-func (o *ClientOptions) SetProtocolVersion(pv uint) *ClientOptions {
-	if (pv >= 3 && pv <= 4) || (pv > 0x80) {
-		o.ProtocolVersion = pv
-		o.protocolVersionExplicit = true
-	}
-	return o
-}
-
-// UnsetWill will cause any set will message to be disregarded.
-func (o *ClientOptions) UnsetWill() *ClientOptions {
-	o.WillEnabled = false
-	return o
-}
-
-// SetWill accepts a string will message to be set. When the client connects,
-// it will give this will message to the broker, which will then publish the
-// provided payload (the will) to any clients that are subscribed to the provided
-// topic.
-func (o *ClientOptions) SetWill(topic string, payload string, qos byte, retained bool) *ClientOptions {
-	o.SetBinaryWill(topic, []byte(payload), qos, retained)
-	return o
-}
-
-// SetBinaryWill accepts a []byte will message to be set. When the client connects,
-// it will give this will message to the broker, which will then publish the
-// provided payload (the will) to any clients that are subscribed to the provided
-// topic.
-func (o *ClientOptions) SetBinaryWill(topic string, payload []byte, qos byte, retained bool) *ClientOptions {
-	o.WillEnabled = true
-	o.WillTopic = topic
-	o.WillPayload = payload
-	o.WillQos = qos
-	o.WillRetained = retained
-	return o
-}
-
-// SetDefaultPublishHandler sets the MessageHandler that will be called when a message
-// is received that does not match any known subscriptions.
-//
-// If OrderMatters is true (the defaultHandler) then callback must not block or
-// call functions within this package that may block (e.g. Publish) other than in
-// a new go routine.
-// defaultHandler must be safe for concurrent use by multiple goroutines.
-func (o *ClientOptions) SetDefaultPublishHandler(defaultHandler MessageHandler) *ClientOptions {
-	o.DefaultPublishHandler = defaultHandler
-	return o
-}
-
-// SetOnConnectHandler sets the function to be called when the client is connected. Both
-// at initial connection time and upon automatic reconnect.
-func (o *ClientOptions) SetOnConnectHandler(onConn OnConnectHandler) *ClientOptions {
-	o.OnConnect = onConn
-	return o
-}
-
-// SetConnectionLostHandler will set the OnConnectionLost callback to be executed
-// in the case where the client unexpectedly loses connection with the MQTT broker.
-func (o *ClientOptions) SetConnectionLostHandler(onLost ConnectionLostHandler) *ClientOptions {
-	o.OnConnectionLost = onLost
-	return o
-}
-
-// SetReconnectingHandler sets the OnReconnecting callback to be executed prior
-// to the client attempting a reconnect to the MQTT broker.
-func (o *ClientOptions) SetReconnectingHandler(cb ReconnectHandler) *ClientOptions {
-	o.OnReconnecting = cb
-	return o
-}
-
-// SetConnectionAttemptHandler sets the ConnectionAttemptHandler callback to be executed prior
-// to each attempt to connect to an MQTT broker. Returns the *tls.Config that will be used when establishing
-// the connection (a copy of the tls.Config from ClientOptions will be passed in along with the broker URL).
-// This allows connection specific changes to be made to the *tls.Config.
-func (o *ClientOptions) SetConnectionAttemptHandler(onConnectAttempt ConnectionAttemptHandler) *ClientOptions {
-	o.OnConnectAttempt = onConnectAttempt
-	return o
-}
-
-// SetConnectionNotificationHandler sets the ConnectionNotificationHandler callback to receive all types of connection
-// events.
-func (o *ClientOptions) SetConnectionNotificationHandler(onConnectionNotification ConnectionNotificationHandler) *ClientOptions {
-	o.OnConnectionNotification = onConnectionNotification
-	return o
-}
-
-// SetWriteTimeout puts a limit on how long a mqtt publish should block until it unblocks with a
-// timeout error. A duration of 0 never times out. Default never times out
-func (o *ClientOptions) SetWriteTimeout(t time.Duration) *ClientOptions {
-	o.WriteTimeout = t
-	return o
-}
-
-// SetConnectTimeout limits how long the client will wait when trying to open a connection
-// to an MQTT server before timing out. A duration of 0 never times out.
-// Default 30 seconds. Currently only operational on TCP/TLS connections.
-func (o *ClientOptions) SetConnectTimeout(t time.Duration) *ClientOptions {
-	o.ConnectTimeout = t
-	o.Dialer.Timeout = t
-	return o
-}
-
-// SetMaxReconnectInterval sets the maximum time that will be waited between reconnection attempts
-// when connection is lost
-func (o *ClientOptions) SetMaxReconnectInterval(t time.Duration) *ClientOptions {
-	o.MaxReconnectInterval = t
-	return o
-}
-
-// SetAutoReconnect sets whether the automatic reconnection logic should be used
-// when the connection is lost, even if disabled the ConnectionLostHandler is still
-// called
-func (o *ClientOptions) SetAutoReconnect(a bool) *ClientOptions {
-	o.AutoReconnect = a
-	return o
-}
-
-// SetConnectRetryInterval sets the time that will be waited between connection attempts
-// when initially connecting if ConnectRetry is TRUE
-func (o *ClientOptions) SetConnectRetryInterval(t time.Duration) *ClientOptions {
-	o.ConnectRetryInterval = t
-	return o
-}
-
-// SetConnectRetry sets whether the connect function will automatically retry the connection
-// in the event of a failure (when true the token returned by the Connect function will
-// not complete until the connection is up or it is cancelled)
-// If ConnectRetry is true then subscriptions should be requested in OnConnect handler
-// Setting this to TRUE permits messages to be published before the connection is established
-func (o *ClientOptions) SetConnectRetry(a bool) *ClientOptions {
-	o.ConnectRetry = a
-	return o
-}
-
-// SetMessageChannelDepth DEPRECATED The value set here no longer has any effect, this function
-// remains so the API is not altered.
-func (o *ClientOptions) SetMessageChannelDepth(s uint) *ClientOptions {
-	o.MessageChannelDepth = s
-	return o
-}
-
-// SetHTTPHeaders sets the additional HTTP headers that will be sent in the WebSocket
-// opening handshake.
-func (o *ClientOptions) SetHTTPHeaders(h http.Header) *ClientOptions {
-	o.HTTPHeaders = h
-	return o
-}
-
-// SetWebsocketOptions sets the additional websocket options used in a WebSocket connection
-func (o *ClientOptions) SetWebsocketOptions(w *WebsocketOptions) *ClientOptions {
-	o.WebsocketOptions = w
-	return o
-}
-
-// SetMaxResumePubInFlight sets the maximum simultaneous publish messages that will be sent while resuming. Note that
-// this only applies to messages coming from the store (so additional sends may push us over the limit)
-// Note that the connect token will not be flagged as complete until all messages have been sent from the
-// store. If broker does not respond to messages then resume may not complete.
-// This option was put in place because resuming after downtime can saturate low capacity links.
-func (o *ClientOptions) SetMaxResumePubInFlight(MaxResumePubInFlight int) *ClientOptions {
-	o.MaxResumePubInFlight = MaxResumePubInFlight
-	return o
-}
-
-// SetDialer sets the tcp dialer options used in a tcp connection
-func (o *ClientOptions) SetDialer(dialer *net.Dialer) *ClientOptions {
-	o.Dialer = dialer
-	return o
-}
-
-// SetCustomOpenConnectionFn replaces the inbuilt function that establishes a network connection with a custom function.
-// The passed in function should return an open `net.Conn` or an error (see the existing openConnection function for an example)
-// It enables custom networking types in addition to the defaults (tcp, tls, websockets...)
-func (o *ClientOptions) SetCustomOpenConnectionFn(customOpenConnectionFn OpenConnectionFunc) *ClientOptions {
-	if customOpenConnectionFn != nil {
-		o.CustomOpenConnectionFn = customOpenConnectionFn
-	}
-	return o
-}
-
-// SetAutoAckDisabled enables or disables the Automated Acking of Messages received by the handler.
-//
-//	By default it is set to false. Setting it to true will disable the auto-ack globally.
-func (o *ClientOptions) SetAutoAckDisabled(autoAckDisabled bool) *ClientOptions {
-	o.AutoAckDisabled = autoAckDisabled
-	return o
-}

vendor/github.com/eclipse/paho.mqtt.golang/options_reader.go

@@ -1,186 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- */
-
-package mqtt
-
-import (
-	"crypto/tls"
-	"net/http"
-	"net/url"
-	"time"
-)
-
-// ClientOptionsReader provides an interface for reading ClientOptions after the client has been initialized.
-type ClientOptionsReader struct {
-	options *ClientOptions
-}
-
-// NewOptionsReader creates a ClientOptionsReader, this should only be used for mocking purposes.
-//
-// An example implementation:
-//
-//	func (c *mqttClientMock) OptionsReader() mqtt.ClientOptionsReader {
-//		opts := mqtt.NewClientOptions()
-//		opts.UserName = "TestUserName"
-//		return mqtt.NewOptionsReader(opts)
-//	}
-func NewOptionsReader(o *ClientOptions) ClientOptionsReader {
-	return ClientOptionsReader{
-		options: o,
-	}
-}
-
-// Servers returns a slice of the servers defined in the clientoptions
-func (r *ClientOptionsReader) Servers() []*url.URL {
-	s := make([]*url.URL, len(r.options.Servers))
-
-	for i, u := range r.options.Servers {
-		nu := *u
-		s[i] = &nu
-	}
-
-	return s
-}
-
-// ResumeSubs returns true if resuming stored (un)sub is enabled
-func (r *ClientOptionsReader) ResumeSubs() bool {
-	s := r.options.ResumeSubs
-	return s
-}
-
-// ClientID returns the set client id
-func (r *ClientOptionsReader) ClientID() string {
-	s := r.options.ClientID
-	return s
-}
-
-// Username returns the set username
-func (r *ClientOptionsReader) Username() string {
-	s := r.options.Username
-	return s
-}
-
-// Password returns the set password
-func (r *ClientOptionsReader) Password() string {
-	s := r.options.Password
-	return s
-}
-
-// CleanSession returns whether Cleansession is set
-func (r *ClientOptionsReader) CleanSession() bool {
-	s := r.options.CleanSession
-	return s
-}
-
-func (r *ClientOptionsReader) Order() bool {
-	s := r.options.Order
-	return s
-}
-
-func (r *ClientOptionsReader) WillEnabled() bool {
-	s := r.options.WillEnabled
-	return s
-}
-
-func (r *ClientOptionsReader) WillTopic() string {
-	s := r.options.WillTopic
-	return s
-}
-
-func (r *ClientOptionsReader) WillPayload() []byte {
-	s := r.options.WillPayload
-	return s
-}
-
-func (r *ClientOptionsReader) WillQos() byte {
-	s := r.options.WillQos
-	return s
-}
-
-func (r *ClientOptionsReader) WillRetained() bool {
-	s := r.options.WillRetained
-	return s
-}
-
-func (r *ClientOptionsReader) ProtocolVersion() uint {
-	s := r.options.ProtocolVersion
-	return s
-}
-
-func (r *ClientOptionsReader) TLSConfig() *tls.Config {
-	s := r.options.TLSConfig
-	return s
-}
-
-func (r *ClientOptionsReader) KeepAlive() time.Duration {
-	s := time.Duration(r.options.KeepAlive * int64(time.Second))
-	return s
-}
-
-func (r *ClientOptionsReader) PingTimeout() time.Duration {
-	s := r.options.PingTimeout
-	return s
-}
-
-func (r *ClientOptionsReader) ConnectTimeout() time.Duration {
-	s := r.options.ConnectTimeout
-	return s
-}
-
-func (r *ClientOptionsReader) MaxReconnectInterval() time.Duration {
-	s := r.options.MaxReconnectInterval
-	return s
-}
-
-func (r *ClientOptionsReader) AutoReconnect() bool {
-	s := r.options.AutoReconnect
-	return s
-}
-
-// ConnectRetryInterval returns the delay between retries on the initial connection (if ConnectRetry true)
-func (r *ClientOptionsReader) ConnectRetryInterval() time.Duration {
-	s := r.options.ConnectRetryInterval
-	return s
-}
-
-// ConnectRetry returns whether the initial connection request will be retried until connection established
-func (r *ClientOptionsReader) ConnectRetry() bool {
-	s := r.options.ConnectRetry
-	return s
-}
-
-func (r *ClientOptionsReader) WriteTimeout() time.Duration {
-	s := r.options.WriteTimeout
-	return s
-}
-
-func (r *ClientOptionsReader) MessageChannelDepth() uint {
-	s := r.options.MessageChannelDepth
-	return s
-}
-
-func (r *ClientOptionsReader) HTTPHeaders() http.Header {
-	h := r.options.HTTPHeaders
-	return h
-}
-
-// WebsocketOptions returns the currently configured WebSocket options
-func (r *ClientOptionsReader) WebsocketOptions() *WebsocketOptions {
-	s := r.options.WebsocketOptions
-	return s
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/connack.go

@@ -1,68 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-)
-
-// ConnackPacket is an internal representation of the fields of the
-// Connack MQTT packet
-type ConnackPacket struct {
-	FixedHeader
-	SessionPresent bool
-	ReturnCode     byte
-}
-
-func (ca *ConnackPacket) String() string {
-	return fmt.Sprintf("%s sessionpresent: %t returncode: %d", ca.FixedHeader, ca.SessionPresent, ca.ReturnCode)
-}
-
-func (ca *ConnackPacket) Write(w io.Writer) error {
-	var body bytes.Buffer
-	var err error
-
-	body.WriteByte(boolToByte(ca.SessionPresent))
-	body.WriteByte(ca.ReturnCode)
-	ca.FixedHeader.RemainingLength = 2
-	packet := ca.FixedHeader.pack()
-	packet.Write(body.Bytes())
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (ca *ConnackPacket) Unpack(b io.Reader) error {
-	flags, err := decodeByte(b)
-	if err != nil {
-		return err
-	}
-	ca.SessionPresent = 1&flags > 0
-	ca.ReturnCode, err = decodeByte(b)
-
-	return err
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (ca *ConnackPacket) Details() Details {
-	return Details{Qos: 0, MessageID: 0}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/connect.go

@@ -1,171 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-)
-
-// ConnectPacket is an internal representation of the fields of the
-// Connect MQTT packet
-type ConnectPacket struct {
-	FixedHeader
-	ProtocolName    string
-	ProtocolVersion byte
-	CleanSession    bool
-	WillFlag        bool
-	WillQos         byte
-	WillRetain      bool
-	UsernameFlag    bool
-	PasswordFlag    bool
-	ReservedBit     byte
-	Keepalive       uint16
-
-	ClientIdentifier string
-	WillTopic        string
-	WillMessage      []byte
-	Username         string
-	Password         []byte
-}
-
-func (c *ConnectPacket) String() string {
-	var password string
-	if len(c.Password) > 0 {
-		password = "<redacted>"
-	}
-	return fmt.Sprintf("%s protocolversion: %d protocolname: %s cleansession: %t willflag: %t WillQos: %d WillRetain: %t Usernameflag: %t Passwordflag: %t keepalive: %d clientId: %s willtopic: %s willmessage: %s Username: %s Password: %s", c.FixedHeader, c.ProtocolVersion, c.ProtocolName, c.CleanSession, c.WillFlag, c.WillQos, c.WillRetain, c.UsernameFlag, c.PasswordFlag, c.Keepalive, c.ClientIdentifier, c.WillTopic, c.WillMessage, c.Username, password)
-}
-
-func (c *ConnectPacket) Write(w io.Writer) error {
-	var body bytes.Buffer
-	var err error
-
-	body.Write(encodeString(c.ProtocolName))
-	body.WriteByte(c.ProtocolVersion)
-	body.WriteByte(boolToByte(c.CleanSession)<<1 | boolToByte(c.WillFlag)<<2 | c.WillQos<<3 | boolToByte(c.WillRetain)<<5 | boolToByte(c.PasswordFlag)<<6 | boolToByte(c.UsernameFlag)<<7)
-	body.Write(encodeUint16(c.Keepalive))
-	body.Write(encodeString(c.ClientIdentifier))
-	if c.WillFlag {
-		body.Write(encodeString(c.WillTopic))
-		body.Write(encodeBytes(c.WillMessage))
-	}
-	if c.UsernameFlag {
-		body.Write(encodeString(c.Username))
-	}
-	if c.PasswordFlag {
-		body.Write(encodeBytes(c.Password))
-	}
-	c.FixedHeader.RemainingLength = body.Len()
-	packet := c.FixedHeader.pack()
-	packet.Write(body.Bytes())
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (c *ConnectPacket) Unpack(b io.Reader) error {
-	var err error
-	c.ProtocolName, err = decodeString(b)
-	if err != nil {
-		return err
-	}
-	c.ProtocolVersion, err = decodeByte(b)
-	if err != nil {
-		return err
-	}
-	options, err := decodeByte(b)
-	if err != nil {
-		return err
-	}
-	c.ReservedBit = 1 & options
-	c.CleanSession = 1&(options>>1) > 0
-	c.WillFlag = 1&(options>>2) > 0
-	c.WillQos = 3 & (options >> 3)
-	c.WillRetain = 1&(options>>5) > 0
-	c.PasswordFlag = 1&(options>>6) > 0
-	c.UsernameFlag = 1&(options>>7) > 0
-	c.Keepalive, err = decodeUint16(b)
-	if err != nil {
-		return err
-	}
-	c.ClientIdentifier, err = decodeString(b)
-	if err != nil {
-		return err
-	}
-	if c.WillFlag {
-		c.WillTopic, err = decodeString(b)
-		if err != nil {
-			return err
-		}
-		c.WillMessage, err = decodeBytes(b)
-		if err != nil {
-			return err
-		}
-	}
-	if c.UsernameFlag {
-		c.Username, err = decodeString(b)
-		if err != nil {
-			return err
-		}
-	}
-	if c.PasswordFlag {
-		c.Password, err = decodeBytes(b)
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-// Validate performs validation of the fields of a Connect packet
-func (c *ConnectPacket) Validate() byte {
-	if c.PasswordFlag && !c.UsernameFlag {
-		return ErrRefusedBadUsernameOrPassword
-	}
-	if c.ReservedBit != 0 {
-		// Bad reserved bit
-		return ErrProtocolViolation
-	}
-	if (c.ProtocolName == "MQIsdp" && c.ProtocolVersion != 3) || (c.ProtocolName == "MQTT" && c.ProtocolVersion != 4) {
-		// Mismatched or unsupported protocol version
-		return ErrRefusedBadProtocolVersion
-	}
-	if c.ProtocolName != "MQIsdp" && c.ProtocolName != "MQTT" {
-		// Bad protocol name
-		return ErrProtocolViolation
-	}
-	if len(c.ClientIdentifier) > 65535 || len(c.Username) > 65535 || len(c.Password) > 65535 {
-		// Bad size field
-		return ErrProtocolViolation
-	}
-	if len(c.ClientIdentifier) == 0 && !c.CleanSession {
-		// Bad client identifier
-		return ErrRefusedIDRejected
-	}
-	return Accepted
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (c *ConnectPacket) Details() Details {
-	return Details{Qos: 0, MessageID: 0}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/disconnect.go

@@ -1,50 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"io"
-)
-
-// DisconnectPacket is an internal representation of the fields of the
-// Disconnect MQTT packet
-type DisconnectPacket struct {
-	FixedHeader
-}
-
-func (d *DisconnectPacket) String() string {
-	return d.FixedHeader.String()
-}
-
-func (d *DisconnectPacket) Write(w io.Writer) error {
-	packet := d.FixedHeader.pack()
-	_, err := packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (d *DisconnectPacket) Unpack(b io.Reader) error {
-	return nil
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (d *DisconnectPacket) Details() Details {
-	return Details{Qos: 0, MessageID: 0}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/packets.go

@@ -1,377 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"bytes"
-	"encoding/binary"
-	"errors"
-	"fmt"
-	"io"
-)
-
-// ControlPacket defines the interface for structs intended to hold
-// decoded MQTT packets, either from being read or before being
-// written
-type ControlPacket interface {
-	Write(io.Writer) error
-	Unpack(io.Reader) error
-	String() string
-	Details() Details
-}
-
-// PacketNames maps the constants for each of the MQTT packet types
-// to a string representation of their name.
-var PacketNames = map[uint8]string{
-	1:  "CONNECT",
-	2:  "CONNACK",
-	3:  "PUBLISH",
-	4:  "PUBACK",
-	5:  "PUBREC",
-	6:  "PUBREL",
-	7:  "PUBCOMP",
-	8:  "SUBSCRIBE",
-	9:  "SUBACK",
-	10: "UNSUBSCRIBE",
-	11: "UNSUBACK",
-	12: "PINGREQ",
-	13: "PINGRESP",
-	14: "DISCONNECT",
-}
-
-// Below are the constants assigned to each of the MQTT packet types
-const (
-	Connect     = 1
-	Connack     = 2
-	Publish     = 3
-	Puback      = 4
-	Pubrec      = 5
-	Pubrel      = 6
-	Pubcomp     = 7
-	Subscribe   = 8
-	Suback      = 9
-	Unsubscribe = 10
-	Unsuback    = 11
-	Pingreq     = 12
-	Pingresp    = 13
-	Disconnect  = 14
-)
-
-// Below are the const definitions for error codes returned by
-// Connect()
-const (
-	Accepted                        = 0x00
-	ErrRefusedBadProtocolVersion    = 0x01
-	ErrRefusedIDRejected            = 0x02
-	ErrRefusedServerUnavailable     = 0x03
-	ErrRefusedBadUsernameOrPassword = 0x04
-	ErrRefusedNotAuthorised         = 0x05
-	ErrNetworkError                 = 0xFE
-	ErrProtocolViolation            = 0xFF
-)
-
-// ConnackReturnCodes is a map of the error codes constants for Connect()
-// to a string representation of the error
-var ConnackReturnCodes = map[uint8]string{
-	0:   "Connection Accepted",
-	1:   "Connection Refused: Bad Protocol Version",
-	2:   "Connection Refused: Client Identifier Rejected",
-	3:   "Connection Refused: Server Unavailable",
-	4:   "Connection Refused: Username or Password in unknown format",
-	5:   "Connection Refused: Not Authorised",
-	254: "Connection Error",
-	255: "Connection Refused: Protocol Violation",
-}
-
-var (
-	ErrorRefusedBadProtocolVersion    = errors.New("unacceptable protocol version")
-	ErrorRefusedIDRejected            = errors.New("identifier rejected")
-	ErrorRefusedServerUnavailable     = errors.New("server Unavailable")
-	ErrorRefusedBadUsernameOrPassword = errors.New("bad user name or password")
-	ErrorRefusedNotAuthorised         = errors.New("not Authorized")
-	ErrorNetworkError                 = errors.New("network Error")
-	ErrorProtocolViolation            = errors.New("protocol Violation")
-)
-
-// ConnErrors is a map of the errors codes constants for Connect()
-// to a Go error
-var ConnErrors = map[byte]error{
-	Accepted:                        nil,
-	ErrRefusedBadProtocolVersion:    ErrorRefusedBadProtocolVersion,
-	ErrRefusedIDRejected:            ErrorRefusedIDRejected,
-	ErrRefusedServerUnavailable:     ErrorRefusedServerUnavailable,
-	ErrRefusedBadUsernameOrPassword: ErrorRefusedBadUsernameOrPassword,
-	ErrRefusedNotAuthorised:         ErrorRefusedNotAuthorised,
-	ErrNetworkError:                 ErrorNetworkError,
-	ErrProtocolViolation:            ErrorProtocolViolation,
-}
-
-// ReadPacket takes an instance of an io.Reader (such as net.Conn) and attempts
-// to read an MQTT packet from the stream. It returns a ControlPacket
-// representing the decoded MQTT packet and an error. One of these returns will
-// always be nil, a nil ControlPacket indicating an error occurred.
-func ReadPacket(r io.Reader) (ControlPacket, error) {
-	var fh FixedHeader
-	b := make([]byte, 1)
-
-	_, err := io.ReadFull(r, b)
-	if err != nil {
-		return nil, err
-	}
-
-	err = fh.unpack(b[0], r)
-	if err != nil {
-		return nil, err
-	}
-
-	cp, err := NewControlPacketWithHeader(fh)
-	if err != nil {
-		return nil, err
-	}
-
-	packetBytes := make([]byte, fh.RemainingLength)
-	n, err := io.ReadFull(r, packetBytes)
-	if err != nil {
-		return nil, err
-	}
-	if n != fh.RemainingLength {
-		return nil, errors.New("failed to read expected data")
-	}
-
-	err = cp.Unpack(bytes.NewBuffer(packetBytes))
-	return cp, err
-}
-
-// NewControlPacket is used to create a new ControlPacket of the type specified
-// by packetType, this is usually done by reference to the packet type constants
-// defined in packets.go. The newly created ControlPacket is empty and a pointer
-// is returned.
-func NewControlPacket(packetType byte) ControlPacket {
-	switch packetType {
-	case Connect:
-		return &ConnectPacket{FixedHeader: FixedHeader{MessageType: Connect}}
-	case Connack:
-		return &ConnackPacket{FixedHeader: FixedHeader{MessageType: Connack}}
-	case Disconnect:
-		return &DisconnectPacket{FixedHeader: FixedHeader{MessageType: Disconnect}}
-	case Publish:
-		return &PublishPacket{FixedHeader: FixedHeader{MessageType: Publish}}
-	case Puback:
-		return &PubackPacket{FixedHeader: FixedHeader{MessageType: Puback}}
-	case Pubrec:
-		return &PubrecPacket{FixedHeader: FixedHeader{MessageType: Pubrec}}
-	case Pubrel:
-		return &PubrelPacket{FixedHeader: FixedHeader{MessageType: Pubrel, Qos: 1}}
-	case Pubcomp:
-		return &PubcompPacket{FixedHeader: FixedHeader{MessageType: Pubcomp}}
-	case Subscribe:
-		return &SubscribePacket{FixedHeader: FixedHeader{MessageType: Subscribe, Qos: 1}}
-	case Suback:
-		return &SubackPacket{FixedHeader: FixedHeader{MessageType: Suback}}
-	case Unsubscribe:
-		return &UnsubscribePacket{FixedHeader: FixedHeader{MessageType: Unsubscribe, Qos: 1}}
-	case Unsuback:
-		return &UnsubackPacket{FixedHeader: FixedHeader{MessageType: Unsuback}}
-	case Pingreq:
-		return &PingreqPacket{FixedHeader: FixedHeader{MessageType: Pingreq}}
-	case Pingresp:
-		return &PingrespPacket{FixedHeader: FixedHeader{MessageType: Pingresp}}
-	}
-	return nil
-}
-
-// NewControlPacketWithHeader is used to create a new ControlPacket of the type
-// specified within the FixedHeader that is passed to the function.
-// The newly created ControlPacket is empty and a pointer is returned.
-func NewControlPacketWithHeader(fh FixedHeader) (ControlPacket, error) {
-	switch fh.MessageType {
-	case Connect:
-		return &ConnectPacket{FixedHeader: fh}, nil
-	case Connack:
-		return &ConnackPacket{FixedHeader: fh}, nil
-	case Disconnect:
-		return &DisconnectPacket{FixedHeader: fh}, nil
-	case Publish:
-		return &PublishPacket{FixedHeader: fh}, nil
-	case Puback:
-		return &PubackPacket{FixedHeader: fh}, nil
-	case Pubrec:
-		return &PubrecPacket{FixedHeader: fh}, nil
-	case Pubrel:
-		return &PubrelPacket{FixedHeader: fh}, nil
-	case Pubcomp:
-		return &PubcompPacket{FixedHeader: fh}, nil
-	case Subscribe:
-		return &SubscribePacket{FixedHeader: fh}, nil
-	case Suback:
-		return &SubackPacket{FixedHeader: fh}, nil
-	case Unsubscribe:
-		return &UnsubscribePacket{FixedHeader: fh}, nil
-	case Unsuback:
-		return &UnsubackPacket{FixedHeader: fh}, nil
-	case Pingreq:
-		return &PingreqPacket{FixedHeader: fh}, nil
-	case Pingresp:
-		return &PingrespPacket{FixedHeader: fh}, nil
-	}
-	return nil, fmt.Errorf("unsupported packet type 0x%x", fh.MessageType)
-}
-
-// Details struct returned by the Details() function called on
-// ControlPackets to present details of the Qos and MessageID
-// of the ControlPacket
-type Details struct {
-	Qos       byte
-	MessageID uint16
-}
-
-// FixedHeader is a struct to hold the decoded information from
-// the fixed header of an MQTT ControlPacket
-type FixedHeader struct {
-	MessageType     byte
-	Dup             bool
-	Qos             byte
-	Retain          bool
-	RemainingLength int
-}
-
-func (fh FixedHeader) String() string {
-	return fmt.Sprintf("%s: dup: %t qos: %d retain: %t rLength: %d", PacketNames[fh.MessageType], fh.Dup, fh.Qos, fh.Retain, fh.RemainingLength)
-}
-
-func boolToByte(b bool) byte {
-	switch b {
-	case true:
-		return 1
-	default:
-		return 0
-	}
-}
-
-func (fh *FixedHeader) pack() bytes.Buffer {
-	var header bytes.Buffer
-	header.WriteByte(fh.MessageType<<4 | boolToByte(fh.Dup)<<3 | fh.Qos<<1 | boolToByte(fh.Retain))
-	header.Write(encodeLength(fh.RemainingLength))
-	return header
-}
-
-func (fh *FixedHeader) unpack(typeAndFlags byte, r io.Reader) error {
-	fh.MessageType = typeAndFlags >> 4
-	fh.Dup = (typeAndFlags>>3)&0x01 > 0
-	fh.Qos = (typeAndFlags >> 1) & 0x03
-	fh.Retain = typeAndFlags&0x01 > 0
-
-	var err error
-	fh.RemainingLength, err = decodeLength(r)
-	return err
-}
-
-func decodeByte(b io.Reader) (byte, error) {
-	num := make([]byte, 1)
-	_, err := b.Read(num)
-	if err != nil {
-		return 0, err
-	}
-
-	return num[0], nil
-}
-
-func decodeUint16(b io.Reader) (uint16, error) {
-	num := make([]byte, 2)
-	_, err := b.Read(num)
-	if err != nil {
-		return 0, err
-	}
-	return binary.BigEndian.Uint16(num), nil
-}
-
-func encodeUint16(num uint16) []byte {
-	bytesResult := make([]byte, 2)
-	binary.BigEndian.PutUint16(bytesResult, num)
-	return bytesResult
-}
-
-func encodeString(field string) []byte {
-	return encodeBytes([]byte(field))
-}
-
-func decodeString(b io.Reader) (string, error) {
-	buf, err := decodeBytes(b)
-	return string(buf), err
-}
-
-func decodeBytes(b io.Reader) ([]byte, error) {
-	fieldLength, err := decodeUint16(b)
-	if err != nil {
-		return nil, err
-	}
-
-	field := make([]byte, fieldLength)
-	_, err = b.Read(field)
-	if err != nil {
-		return nil, err
-	}
-
-	return field, nil
-}
-
-func encodeBytes(field []byte) []byte {
-	// Attempting to encode more than 65,535 bytes would lead to an unexpected 16-bit length and extra data written
-	// (which would be parsed as later parts of the message). The safest option is to truncate.
-	if len(field) > 65535 {
-		field = field[0:65535]
-	}
-	fieldLength := make([]byte, 2)
-	binary.BigEndian.PutUint16(fieldLength, uint16(len(field)))
-	return append(fieldLength, field...)
-}
-
-func encodeLength(length int) []byte {
-	var encLength []byte
-	for {
-		digit := byte(length % 128)
-		length /= 128
-		if length > 0 {
-			digit |= 0x80
-		}
-		encLength = append(encLength, digit)
-		if length == 0 {
-			break
-		}
-	}
-	return encLength
-}
-
-func decodeLength(r io.Reader) (int, error) {
-	var rLength uint32
-	var multiplier uint32
-	b := make([]byte, 1)
-	for multiplier < 27 { // fix: Infinite '(digit & 128) == 1' will cause the dead loop
-		_, err := io.ReadFull(r, b)
-		if err != nil {
-			return 0, err
-		}
-
-		digit := b[0]
-		rLength |= uint32(digit&127) << multiplier
-		if (digit & 128) == 0 {
-			break
-		}
-		multiplier += 7
-	}
-	return int(rLength), nil
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/pingreq.go

@@ -1,50 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"io"
-)
-
-// PingreqPacket is an internal representation of the fields of the
-// Pingreq MQTT packet
-type PingreqPacket struct {
-	FixedHeader
-}
-
-func (pr *PingreqPacket) String() string {
-	return pr.FixedHeader.String()
-}
-
-func (pr *PingreqPacket) Write(w io.Writer) error {
-	packet := pr.FixedHeader.pack()
-	_, err := packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (pr *PingreqPacket) Unpack(b io.Reader) error {
-	return nil
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (pr *PingreqPacket) Details() Details {
-	return Details{Qos: 0, MessageID: 0}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/pingresp.go

@@ -1,50 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"io"
-)
-
-// PingrespPacket is an internal representation of the fields of the
-// Pingresp MQTT packet
-type PingrespPacket struct {
-	FixedHeader
-}
-
-func (pr *PingrespPacket) String() string {
-	return pr.FixedHeader.String()
-}
-
-func (pr *PingrespPacket) Write(w io.Writer) error {
-	packet := pr.FixedHeader.pack()
-	_, err := packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (pr *PingrespPacket) Unpack(b io.Reader) error {
-	return nil
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (pr *PingrespPacket) Details() Details {
-	return Details{Qos: 0, MessageID: 0}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/puback.go

@@ -1,58 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"fmt"
-	"io"
-)
-
-// PubackPacket is an internal representation of the fields of the
-// Puback MQTT packet
-type PubackPacket struct {
-	FixedHeader
-	MessageID uint16
-}
-
-func (pa *PubackPacket) String() string {
-	return fmt.Sprintf("%s MessageID: %d", pa.FixedHeader, pa.MessageID)
-}
-
-func (pa *PubackPacket) Write(w io.Writer) error {
-	var err error
-	pa.FixedHeader.RemainingLength = 2
-	packet := pa.FixedHeader.pack()
-	packet.Write(encodeUint16(pa.MessageID))
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (pa *PubackPacket) Unpack(b io.Reader) error {
-	var err error
-	pa.MessageID, err = decodeUint16(b)
-
-	return err
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (pa *PubackPacket) Details() Details {
-	return Details{Qos: pa.Qos, MessageID: pa.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/pubcomp.go

@@ -1,58 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"fmt"
-	"io"
-)
-
-// PubcompPacket is an internal representation of the fields of the
-// Pubcomp MQTT packet
-type PubcompPacket struct {
-	FixedHeader
-	MessageID uint16
-}
-
-func (pc *PubcompPacket) String() string {
-	return fmt.Sprintf("%s MessageID: %d", pc.FixedHeader, pc.MessageID)
-}
-
-func (pc *PubcompPacket) Write(w io.Writer) error {
-	var err error
-	pc.FixedHeader.RemainingLength = 2
-	packet := pc.FixedHeader.pack()
-	packet.Write(encodeUint16(pc.MessageID))
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (pc *PubcompPacket) Unpack(b io.Reader) error {
-	var err error
-	pc.MessageID, err = decodeUint16(b)
-
-	return err
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (pc *PubcompPacket) Details() Details {
-	return Details{Qos: pc.Qos, MessageID: pc.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/publish.go

@@ -1,99 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-)
-
-// PublishPacket is an internal representation of the fields of the
-// Publish MQTT packet
-type PublishPacket struct {
-	FixedHeader
-	TopicName string
-	MessageID uint16
-	Payload   []byte
-}
-
-func (p *PublishPacket) String() string {
-	return fmt.Sprintf("%s topicName: %s MessageID: %d payload: %s", p.FixedHeader, p.TopicName, p.MessageID, string(p.Payload))
-}
-
-func (p *PublishPacket) Write(w io.Writer) error {
-	var body bytes.Buffer
-	var err error
-
-	body.Write(encodeString(p.TopicName))
-	if p.Qos > 0 {
-		body.Write(encodeUint16(p.MessageID))
-	}
-	p.FixedHeader.RemainingLength = body.Len() + len(p.Payload)
-	packet := p.FixedHeader.pack()
-	packet.Write(body.Bytes())
-	packet.Write(p.Payload)
-	_, err = w.Write(packet.Bytes())
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (p *PublishPacket) Unpack(b io.Reader) error {
-	var payloadLength = p.FixedHeader.RemainingLength
-	var err error
-	p.TopicName, err = decodeString(b)
-	if err != nil {
-		return err
-	}
-
-	if p.Qos > 0 {
-		p.MessageID, err = decodeUint16(b)
-		if err != nil {
-			return err
-		}
-		payloadLength -= len(p.TopicName) + 4
-	} else {
-		payloadLength -= len(p.TopicName) + 2
-	}
-	if payloadLength < 0 {
-		return fmt.Errorf("error unpacking publish, payload length < 0")
-	}
-	p.Payload = make([]byte, payloadLength)
-	_, err = b.Read(p.Payload)
-
-	return err
-}
-
-// Copy creates a new PublishPacket with the same topic and payload
-// but an empty fixed header, useful for when you want to deliver
-// a message with different properties such as Qos but the same
-// content
-func (p *PublishPacket) Copy() *PublishPacket {
-	newP := NewControlPacket(Publish).(*PublishPacket)
-	newP.TopicName = p.TopicName
-	newP.Payload = p.Payload
-
-	return newP
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (p *PublishPacket) Details() Details {
-	return Details{Qos: p.Qos, MessageID: p.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/pubrec.go

@@ -1,58 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"fmt"
-	"io"
-)
-
-// PubrecPacket is an internal representation of the fields of the
-// Pubrec MQTT packet
-type PubrecPacket struct {
-	FixedHeader
-	MessageID uint16
-}
-
-func (pr *PubrecPacket) String() string {
-	return fmt.Sprintf("%s MessageID: %d", pr.FixedHeader, pr.MessageID)
-}
-
-func (pr *PubrecPacket) Write(w io.Writer) error {
-	var err error
-	pr.FixedHeader.RemainingLength = 2
-	packet := pr.FixedHeader.pack()
-	packet.Write(encodeUint16(pr.MessageID))
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (pr *PubrecPacket) Unpack(b io.Reader) error {
-	var err error
-	pr.MessageID, err = decodeUint16(b)
-
-	return err
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (pr *PubrecPacket) Details() Details {
-	return Details{Qos: pr.Qos, MessageID: pr.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/pubrel.go

@@ -1,58 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"fmt"
-	"io"
-)
-
-// PubrelPacket is an internal representation of the fields of the
-// Pubrel MQTT packet
-type PubrelPacket struct {
-	FixedHeader
-	MessageID uint16
-}
-
-func (pr *PubrelPacket) String() string {
-	return fmt.Sprintf("%s MessageID: %d", pr.FixedHeader, pr.MessageID)
-}
-
-func (pr *PubrelPacket) Write(w io.Writer) error {
-	var err error
-	pr.FixedHeader.RemainingLength = 2
-	packet := pr.FixedHeader.pack()
-	packet.Write(encodeUint16(pr.MessageID))
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (pr *PubrelPacket) Unpack(b io.Reader) error {
-	var err error
-	pr.MessageID, err = decodeUint16(b)
-
-	return err
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (pr *PubrelPacket) Details() Details {
-	return Details{Qos: pr.Qos, MessageID: pr.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/suback.go

@@ -1,73 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-)
-
-// SubackPacket is an internal representation of the fields of the
-// Suback MQTT packet
-type SubackPacket struct {
-	FixedHeader
-	MessageID   uint16
-	ReturnCodes []byte
-}
-
-func (sa *SubackPacket) String() string {
-	return fmt.Sprintf("%s MessageID: %d", sa.FixedHeader, sa.MessageID)
-}
-
-func (sa *SubackPacket) Write(w io.Writer) error {
-	var body bytes.Buffer
-	var err error
-	body.Write(encodeUint16(sa.MessageID))
-	body.Write(sa.ReturnCodes)
-	sa.FixedHeader.RemainingLength = body.Len()
-	packet := sa.FixedHeader.pack()
-	packet.Write(body.Bytes())
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (sa *SubackPacket) Unpack(b io.Reader) error {
-	var qosBuffer bytes.Buffer
-	var err error
-	sa.MessageID, err = decodeUint16(b)
-	if err != nil {
-		return err
-	}
-
-	_, err = qosBuffer.ReadFrom(b)
-	if err != nil {
-		return err
-	}
-	sa.ReturnCodes = qosBuffer.Bytes()
-
-	return nil
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (sa *SubackPacket) Details() Details {
-	return Details{Qos: 0, MessageID: sa.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/subscribe.go

@@ -1,85 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-)
-
-// SubscribePacket is an internal representation of the fields of the
-// Subscribe MQTT packet
-type SubscribePacket struct {
-	FixedHeader
-	MessageID uint16
-	Topics    []string
-	Qoss      []byte
-}
-
-func (s *SubscribePacket) String() string {
-	return fmt.Sprintf("%s MessageID: %d topics: %s", s.FixedHeader, s.MessageID, s.Topics)
-}
-
-func (s *SubscribePacket) Write(w io.Writer) error {
-	var body bytes.Buffer
-	var err error
-
-	body.Write(encodeUint16(s.MessageID))
-	for i, topic := range s.Topics {
-		body.Write(encodeString(topic))
-		body.WriteByte(s.Qoss[i])
-	}
-	s.FixedHeader.RemainingLength = body.Len()
-	packet := s.FixedHeader.pack()
-	packet.Write(body.Bytes())
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (s *SubscribePacket) Unpack(b io.Reader) error {
-	var err error
-	s.MessageID, err = decodeUint16(b)
-	if err != nil {
-		return err
-	}
-	payloadLength := s.FixedHeader.RemainingLength - 2
-	for payloadLength > 0 {
-		topic, err := decodeString(b)
-		if err != nil {
-			return err
-		}
-		s.Topics = append(s.Topics, topic)
-		qos, err := decodeByte(b)
-		if err != nil {
-			return err
-		}
-		s.Qoss = append(s.Qoss, qos)
-		payloadLength -= 2 + len(topic) + 1 // 2 bytes of string length, plus string, plus 1 byte for Qos
-	}
-
-	return nil
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (s *SubscribePacket) Details() Details {
-	return Details{Qos: 1, MessageID: s.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/unsuback.go

@@ -1,58 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"fmt"
-	"io"
-)
-
-// UnsubackPacket is an internal representation of the fields of the
-// Unsuback MQTT packet
-type UnsubackPacket struct {
-	FixedHeader
-	MessageID uint16
-}
-
-func (ua *UnsubackPacket) String() string {
-	return fmt.Sprintf("%s MessageID: %d", ua.FixedHeader, ua.MessageID)
-}
-
-func (ua *UnsubackPacket) Write(w io.Writer) error {
-	var err error
-	ua.FixedHeader.RemainingLength = 2
-	packet := ua.FixedHeader.pack()
-	packet.Write(encodeUint16(ua.MessageID))
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (ua *UnsubackPacket) Unpack(b io.Reader) error {
-	var err error
-	ua.MessageID, err = decodeUint16(b)
-
-	return err
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (ua *UnsubackPacket) Details() Details {
-	return Details{Qos: 0, MessageID: ua.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/packets/unsubscribe.go

@@ -1,72 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Allan Stockdill-Mander
- */
-
-package packets
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-)
-
-// UnsubscribePacket is an internal representation of the fields of the
-// Unsubscribe MQTT packet
-type UnsubscribePacket struct {
-	FixedHeader
-	MessageID uint16
-	Topics    []string
-}
-
-func (u *UnsubscribePacket) String() string {
-	return fmt.Sprintf("%s MessageID: %d", u.FixedHeader, u.MessageID)
-}
-
-func (u *UnsubscribePacket) Write(w io.Writer) error {
-	var body bytes.Buffer
-	var err error
-	body.Write(encodeUint16(u.MessageID))
-	for _, topic := range u.Topics {
-		body.Write(encodeString(topic))
-	}
-	u.FixedHeader.RemainingLength = body.Len()
-	packet := u.FixedHeader.pack()
-	packet.Write(body.Bytes())
-	_, err = packet.WriteTo(w)
-
-	return err
-}
-
-// Unpack decodes the details of a ControlPacket after the fixed
-// header has been read
-func (u *UnsubscribePacket) Unpack(b io.Reader) error {
-	var err error
-	u.MessageID, err = decodeUint16(b)
-	if err != nil {
-		return err
-	}
-
-	for topic, err := decodeString(b); err == nil && topic != ""; topic, err = decodeString(b) {
-		u.Topics = append(u.Topics, topic)
-	}
-
-	return err
-}
-
-// Details returns a Details struct containing the Qos and
-// MessageID of this ControlPacket
-func (u *UnsubscribePacket) Details() Details {
-	return Details{Qos: 1, MessageID: u.MessageID}
-}

vendor/github.com/eclipse/paho.mqtt.golang/ping.go

@@ -1,78 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- */
-
-package mqtt
-
-import (
-	"errors"
-	"io"
-	"sync/atomic"
-	"time"
-
-	"github.com/eclipse/paho.mqtt.golang/packets"
-)
-
-// keepalive - Send ping when connection unused for set period
-// connection passed in to avoid race condition on shutdown
-func keepalive(c *client, conn io.Writer) {
-	defer c.workers.Done()
-	DEBUG.Println(PNG, "keepalive starting")
-	var checkInterval time.Duration
-	var pingSent time.Time
-
-	if c.options.KeepAlive > 10 {
-		checkInterval = 5 * time.Second
-	} else {
-		checkInterval = time.Duration(c.options.KeepAlive) * time.Second / 4
-	}
-
-	intervalTicker := time.NewTicker(checkInterval)
-	defer intervalTicker.Stop()
-
-	for {
-		select {
-		case <-c.stop:
-			DEBUG.Println(PNG, "keepalive stopped")
-			return
-		case <-intervalTicker.C:
-			lastSent := c.lastSent.Load().(time.Time)
-			lastReceived := c.lastReceived.Load().(time.Time)
-
-			DEBUG.Println(PNG, "ping check", time.Since(lastSent).Seconds())
-			if time.Since(lastSent) >= time.Duration(c.options.KeepAlive*int64(time.Second)) || time.Since(lastReceived) >= time.Duration(c.options.KeepAlive*int64(time.Second)) {
-				if atomic.LoadInt32(&c.pingOutstanding) == 0 {
-					DEBUG.Println(PNG, "keepalive sending ping")
-					ping := packets.NewControlPacket(packets.Pingreq).(*packets.PingreqPacket)
-					// We don't want to wait behind large messages being sent, the `Write` call
-					// will block until it is able to send the packet.
-					atomic.StoreInt32(&c.pingOutstanding, 1)
-					if err := ping.Write(conn); err != nil {
-						ERROR.Println(PNG, err)
-					}
-					c.lastSent.Store(time.Now())
-					pingSent = time.Now()
-				}
-			}
-			if atomic.LoadInt32(&c.pingOutstanding) > 0 && time.Since(pingSent) >= c.options.PingTimeout {
-				CRITICAL.Println(PNG, "pingresp not received, disconnecting")
-				c.internalConnLost(errors.New("pingresp not received, disconnecting")) // no harm in calling this if the connection is already down (or shutdown is in progress)
-				return
-			}
-		}
-	}
-}

vendor/github.com/eclipse/paho.mqtt.golang/router.go

@@ -1,214 +0,0 @@
-/*
- * Copyright (c) 2021 IBM Corp and others.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    https://www.eclipse.org/legal/epl-2.0/
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *    Seth Hoenig
- *    Allan Stockdill-Mander
- *    Mike Robertson
- */
-
-package mqtt
-
-import (
-	"container/list"
-	"strings"
-	"sync"
-
-	"github.com/eclipse/paho.mqtt.golang/packets"
-)
-
-// route is a type which associates MQTT Topic strings with a
-// callback to be executed upon the arrival of a message associated
-// with a subscription to that topic.
-type route struct {
-	topic    string
-	callback MessageHandler
-}
-
-// match takes a slice of strings which represent the route being tested having been split on '/'
-// separators, and a slice of strings representing the topic string in the published message, similarly
-// split.
-// The function determines if the topic string matches the route according to the MQTT topic rules
-// and returns a boolean of the outcome
-func match(route []string, topic []string) bool {
-	if len(route) == 0 {
-		return len(topic) == 0
-	}
-
-	if len(topic) == 0 {
-		return route[0] == "#"
-	}
-
-	if route[0] == "#" {
-		return true
-	}
-
-	if (route[0] == "+") || (route[0] == topic[0]) {
-		return match(route[1:], topic[1:])
-	}
-	return false
-}
-
-func routeIncludesTopic(route, topic string) bool {
-	return match(routeSplit(route), strings.Split(topic, "/"))
-}
-
-// removes $share and sharename when splitting the route to allow
-// shared subscription routes to correctly match the topic
-func routeSplit(route string) []string {
-	var result []string
-	if strings.HasPrefix(route, "$share") {
-		result = strings.Split(route, "/")[2:]
-	} else {
-		result = strings.Split(route, "/")
-	}
-	return result
-}
-
-// match takes the topic string of the published message and does a basic compare to the
-// string of the current Route, if they match it returns true
-func (r *route) match(topic string) bool {
-	return r.topic == topic || routeIncludesTopic(r.topic, topic)
-}
-
-type router struct {
-	sync.RWMutex
-	routes         *list.List
-	defaultHandler MessageHandler
-	messages       chan *packets.PublishPacket
-}
-
-// newRouter returns a new instance of a Router and channel which can be used to tell the Router
-// to stop
-func newRouter() *router {
-	router := &router{routes: list.New(), messages: make(chan *packets.PublishPacket)}
-	return router
-}
-
-// addRoute takes a topic string and MessageHandler callback. It looks in the current list of
-// routes to see if there is already a matching Route. If there is it replaces the current
-// callback with the new one. If not it add a new entry to the list of Routes.
-func (r *router) addRoute(topic string, callback MessageHandler) {
-	r.Lock()
-	defer r.Unlock()
-	for e := r.routes.Front(); e != nil; e = e.Next() {
-		if e.Value.(*route).topic == topic {
-			r := e.Value.(*route)
-			r.callback = callback
-			return
-		}
-	}
-	r.routes.PushBack(&route{topic: topic, callback: callback})
-}
-
-// deleteRoute takes a route string, looks for a matching Route in the list of Routes. If
-// found it removes the Route from the list.
-func (r *router) deleteRoute(topic string) {
-	r.Lock()
-	defer r.Unlock()
-	for e := r.routes.Front(); e != nil; e = e.Next() {
-		if e.Value.(*route).topic == topic {
-			r.routes.Remove(e)
-			return
-		}
-	}
-}
-
-// setDefaultHandler assigns a default callback that will be called if no matching Route
-// is found for an incoming Publish.
-func (r *router) setDefaultHandler(handler MessageHandler) {
-	r.Lock()
-	defer r.Unlock()
-	r.defaultHandler = handler
-}
-
-// matchAndDispatch takes a channel of Message pointers as input and starts a go routine that
-// takes messages off the channel, matches them against the internal route list and calls the
-// associated callback (or the defaultHandler, if one exists and no other route matched). If
-// anything is sent down the stop channel the function will end.
-func (r *router) matchAndDispatch(messages <-chan *packets.PublishPacket, order bool, client *client) <-chan *PacketAndToken {
-	ackChan := make(chan *PacketAndToken) // Channel returned to caller; closed when goroutine terminates
-
-	// In some cases message acknowledgments may come through after shutdown (connection is down etc). Where this is the
-	// case we need to accept any such requests and then ignore them. Note that this is not a perfect solution, if we
-	// have reconnected, and the session is still live, then the Ack really should be sent (see Issus #726)
-	var ackMutex sync.RWMutex
-	sendAckChan := ackChan // This will be set to nil before ackChan is closed
-	sendAck := func(ack *PacketAndToken) {
-		ackMutex.RLock()
-		defer ackMutex.RUnlock()
-		if sendAckChan != nil {
-			sendAckChan <- ack
-		} else {
-			DEBUG.Println(ROU, "matchAndDispatch received acknowledgment after processing stopped (ACK dropped).")
-		}
-	}
-
-	go func() { // Main go routine handling inbound messages
-		var handlers []MessageHandler
-		for message := range messages {
-			// DEBUG.Println(ROU, "matchAndDispatch received message")
-			sent := false
-			r.RLock()
-			m := messageFromPublish(message, ackFunc(sendAck, client.persist, message))
-			for e := r.routes.Front(); e != nil; e = e.Next() {
-				if e.Value.(*route).match(message.TopicName) {
-					if order {
-						handlers = append(handlers, e.Value.(*route).callback)
-					} else {
-						hd := e.Value.(*route).callback
-						go func() {
-							hd(client, m)
-							if !client.options.AutoAckDisabled {
-								m.Ack()
-							}
-						}()
-					}
-					sent = true
-				}
-			}
-			if !sent {
-				if r.defaultHandler != nil {
-					if order {
-						handlers = append(handlers, r.defaultHandler)
-					} else {
-						go func() {
-							r.defaultHandler(client, m)
-							if !client.options.AutoAckDisabled {
-								m.Ack()
-							}
-						}()
-					}
-				} else {
-					DEBUG.Println(ROU, "matchAndDispatch received message and no handler was available. Message will NOT be acknowledged.")
-				}
-			}
-			r.RUnlock()
-			if order {
-				for _, handler := range handlers {
-					handler(client, m)
-					if !client.options.AutoAckDisabled {
-						m.Ack()
-					}
-				}
-				handlers = handlers[:0]
-			}
-			// DEBUG.Println(ROU, "matchAndDispatch handled message")
-		}
-		ackMutex.Lock()
-		sendAckChan = nil
-		ackMutex.Unlock()
-		close(ackChan) // as sendAckChan is now nil nothing further will be sent on this
-		DEBUG.Println(ROU, "matchAndDispatch exiting")
-	}()
-	return ackChan
-}