CHANGELOG.md

EdgeX MQTT Device Service

Github repository

Change Logs for EdgeX Dependencies

• device-sdk-go
• go-mod-core-contracts
• go-mod-bootstrap
• go-mod-messaging (indirect dependency)
• go-mod-registry (indirect dependency)
• go-mod-secrets (indirect dependency)
• go-mod-configuration (indirect dependency)

[v3.1.0] Napa - 2023-11-15 (Only compatible with the 3.x releases)

✨ Features

• Remove snap packaging (#635) (aecec81…)

BREAKING CHANGE: Remove snap packaging ([#635](https://github.com/edgexfoundry/device-mqtt-go/issues/635))

♻ Code Refactoring

• Remove github.com/pkg/errors from Attribution.txt (a383cfd…)

👷 Build

• Upgrade to go-1.21, Linter1.54.2 and Alpine 3.18 (#624) (9edf56c…)

🤖 Continuous Integration

• Add automated release workflow on tag creation (7b36b08…)

[v3.0.0] Minnesota - 2023-05-31 (Only compatible with the 3.x releases)

Features ✨

• Handle receiving multiple readings in the async payload (#)

  BREAKING CHANGE: The published async payload must now be json containing the resource names and values, even when a single resource is sent. 
                   - Redundant single resource Device Commands (`testrandfloat32`, `testrandfloat64`, `testping` and `testmessage`) in `mqtt.test.device.profile.yml` have be removed.
                     Use the corresponding resource name (`randfloat32`, `randfloat64`, `ping` or `message`) instead.
  

• Make multi-level topics the only implementation (#15e121)

  BREAKING CHANGE: Removed single level topics so that only multi level is used 
  

• Consume SDK interface changes (#24b4e6c8)

  BREAKING CHANGE: Consume SDK interface changes by adding Discover and ValidateDevice func on driver
  

• Update profile Minimum and Maximum to numeric data (#5b00e40)

  BREAKING CHANGE: Update profile Minimum and Maximum to numeric data according to the latest core-contracts changes.
  

• Change configuration and device TOML files to YAML format (#3944987)

  BREAKING CHANGE: Configuration and device files now in YAML format
  

• Updates for common config (#ec4bdb7)

  BREAKING CHANGE: Configuration file changed to remove common config settings
  

• Remove ZeroMQ MessageBus capability (#)

  BREAKING CHANGE: ZeroMQ no longer option for the EdgeX MessageBus
  

Bug Fixes 🐛

• Update logging to avoid leaking messageBus credentials (#51ee6b6)
• snap: Refactor to avoid conflicts with readonly config provider directory (#535) (#c80097c)

Code Refactoring ♻

• Updated secret path to secretName (#dc80312a)

  BREAKING CHANGE: `path` in Secret DTO renamed to `secretName`
  

• Consume device-sdk-go breaking changes (#f6d0510)

  BREAKING CHANGE: update ProtocolDriver implementation for the new ProtocolDriver interface changes
  

• Replace internal topics from config with new constants (#90bb521)

  BREAKING CHANGE: Internal topics no longer configurable, except the base topic.
  

• Rework code for refactored MessageBus Configuration (#5c1f2ce)

  BREAKING CHANGE: MessageQueue renamed to MessageBus and fields changed. See v3 Migration guide.
  

• Use latest SDK for flattened config stem (#6bdfaee)

  BREAKING CHANGE: Location of service configuration in Consul changed to edgex/v3/device-mqtt
  

• snap: Drop the support for legacy snap env options (#bc7652b)

  BREAKING CHANGE: Drop the support for deprecated snap options starting with `env.`
  

• snap: Update command and metadata sourcing (#529) (#1f5b405)

Build 👷

• Update to Go 1.20, Alpine 3.17 and linter v1.51.2 (#acf7416)

[v2.3.0] Levski - 2022-11-09 (Only compatible with the 2.x releases)

Features ✨

• Add Service Metrics configuration (#431) (#b192367)
• Add NATS configuration and build option (#414) (#626368a)
• Add commanding via message configuration (#b1e10e2)
• Add go-winio to attribution (new SPIFFE dependency) (#383) (#7519713)
• snap: add config interface with unique identifier (#6b3f84b)

Bug Fixes 🐛

• replace broker host config with a valid example (#396) (#2c395e9)
• snap: Remove duplicate file copying in install hook (#420) (#1a028d9)

Code Refactoring ♻

• snap: edgex-snap-hooks related upgrade (#397) (#8b7bfd0)

Build 👷

• Upgrade to Go 1.18, fix linter issues and optimize attribution script (#403) (#7e9452b)

[v2.2.0] Kamakura - 2022-05-11 (Only compatible with the 2.x releases)

Features ✨

• Enable security hardening (#ec9d6ac)

Bug Fixes 🐛

• snap: Expose parent directory in device-config plug (#1a2d89f)

Code Refactoring ♻

• snap: Remove redundant content identifier (#302ebdb)

Documentation 📖

• Add deployment section to readme (#330) (#7f14e9a)

Build 👷

• Update to latest SDK w/o ZMQ on windows (#0aab54c)

  BREAKING CHANGE:
  ZeroMQ no longer supported on native Windows for EdgeX
  MessageBus
  

• snap: source metadata from repo (#328) (#195658a)

Continuous Integration 🔄

• gomod changes related for Go 1.17 (#335) (#6506aa6)
• Go 1.17 related changes (#334) (#620914e)

[v2.1.0] Jakarta - 2021-11-18 (Only compatible with the 2.x releases)

Features ✨

• Add support for new Object reading type (#323) (#5b76d0d)
• Update config file to include secrets file parameters (#310) (#c11b57c)
• Add UseMqttLevels capability to pass in metadata (#303) (#7270bca)
• snap: bump edgex-snap-hooks to support secretsfile config (#a36a4aa)

Bug Fixes 🐛

• Update all TOML to use quote and not single-quote (#298) (#255d6e1)

Code Refactoring ♻

Documentation 📖

• Update build status badge (#56d1e45)
• snap: Fix markdown and replication errors (#8907cac)

Build 👷

• Update to use released SDK (#322) (#ea5b921)
• Update alpine base to 3.14 (#304) (#9a27036)
• snap: Upgrade to snap core20 (#2f4bb9e)

Continuous Integration 🔄

• Remove need for CI specific Dockerfile (#1a605e9)

[v2.0.0] Ireland - 2021-06-30 (Only compatible with the 2.x releases)

Features ✨

• Fix onConnectHandler panics and update config file (#288)
• Using single MQTT broker config (#277) (#056bd70)
• Enable using MessageBus as the default (#279) (#f18a6a3)
• Extract the command response retry interval as configuration (#62ff07c)
• Move Driver config to new custom config section (#5b2c07b)
• Add secure MessagBus capability (#696b33d)
• Remove Logging configuration (#f1a7c6f)
• Updated Dockerfile to install dumb-init (#bc66537)
• Enable use of secret via SecretProvider for MQTT broker credentials (#33a7955)

Bug Fixes 🐛

• Change "."s in profile name to "-"s (#284) (#8213f84)
• Add AuthMode settings so have ability to enable/disable Auth MQTT connections (#269) (#9a33ad5)
• Add Type='vault' to [SecretStore] config (#7c58968)
• Corrected port numbers per PR comments (#dbf9134)
• Added missing InsecureSecrets Section and UseMessageBus = false (#ed2040e)

Code Refactoring ♻

• Change PublishTopicPrefix value to be 'edgex/events/device' (#3890446)
• Rename the custom config name to MQTTBrokerInfo (#d8fe7de)
• Update configuration for change to common ServiceInfo struct (#7ed00ab)

  BREAKING CHANGE:
  Service configuration has changed
  

• Update to assign and uses new Port Assignments (#9e27054)

  BREAKING CHANGE:
  Device MQTT default port number has changed to 59982
  

• rename example device AutoEvent Fequency to Interval (#3a738e3)
• Added go mod tidy to dockerfile (#5919639)
• Update for new service key names and overrides for hyphen to underscore (#356f292)

  BREAKING CHANGE:
  Service key names used in configuration have changed.
  

• use v2 device-sdk (#5a126a9)

Documentation 📖

• Add badges to readme (#cfb712f)

Build 👷

• update build files for zmq dependency (#d53328a)
• deps: bump github.com/eclipse/paho.mqtt.golang (#788356c)
• deps: bump github.com/stretchr/testify from 1.5.1 to 1.7.0 (#5dc0bc9)
• update Dockerfiles to use go 1.16 (#cc189d3)
• update go.mod to go 1.16 (#df72406)
• snap: update go to 1.16 (#941ce85)
• snap: update snap v2 support (#59017e6)

Continuous Integration 🔄

• update local docker image names (#06b6566)

[v1.3.1] - 2021-02-02

Features ✨

• snap: add startup-duration and startup-interval configure options (#bad7e1b)

Build 👷

• deps: bump github.com/edgexfoundry/device-sdk-go (#a154119)

Continuous Integration 🔄

• add semantic.yml for commit linting, update PR template to latest (#692e0b5)
• standardize dockerfiles (#43e9764)

[v1.3.0] - 2020-11-18

Bug Fixes 🐛

• Return error instead of the panic if required config not found (#8630507)
• Modify float value checking condition (#2a661a3)
• local snap development (#8bc9dbb)

Code Refactoring ♻

• Upgrade SDK to v1.2.4-dev.34 (#fe9eb72)
• update dockerfile to appropriately use ENTRYPOINT and CMD, closes#164 (#d7447a9)

Build 👷

• Upgrade to Go1.15 (#b7208c3)
• add dependabot.yml (#730afc1)
• deps: bump github.com/edgexfoundry/device-sdk-go (#61125b8)

[v1.2.2] - 2020-08-19

Snap

• add env override for ProfilesDir (#48947cc)

Bug Fixes 🐛

• Optimize MQTT client creation for async value Add conn retry mechanism and use os.Exit(1) instead of the panic error (#7f88040)

Code Refactoring ♻

• upgrade SDK to v1.2.0 (#863c2d0)

Documentation 📖

• Add standard PR template (#50e33cb)