Skip to content

Release 2.1.0#5

Merged
golluroSICKAG merged 11 commits intoSICKAppSpaceCodingStarterKit:mainfrom
golluroSICKAG:main
May 20, 2025
Merged

Release 2.1.0#5
golluroSICKAG merged 11 commits intoSICKAppSpaceCodingStarterKit:mainfrom
golluroSICKAG:main

Conversation

@golluroSICKAG
Copy link
Copy Markdown
Contributor

@golluroSICKAG golluroSICKAG commented Mar 17, 2025 •
edited
Loading

Release 2.1.0

New features

  • Optionally send a BirthMessage if connected to MQTT broker
  • Optionally set global prefix for all topics
  • Optionally deactivate logging of communication to reduce CPU load
  • Check if persistent data to load provides all relevant parameters. Otherwise add default values

Improvements

  • Check if client is connected to broker before trying to publish

Bugfix

  • Did not use topic prefix for WillMessage
  • Did not update topic prefix / status if WillMessage is active within UI
  • Legacy bindings of ValueDisplay elements within UI did not work if deployed with VS Code AppSpace SDK
  • UI differs if deployed via Appstudio or VS Code AppSpace SDK
  • Fullscreen icon of iFrame was visible

Following tasks were checked

  • Module is coded and structured according to the "Developing guideline for modules" described within the CSK documentation
  • All functions/events/parameters are documented within the manifest documentation
  • The manifest description of the main CROWN includes main information about the purpose of the module and how to use it in general
  • API docu based on the manifest was created and stored within the "docu"-folder of the repository
  • Internal LUA code documentation exists for variables and non served functions
  • All relevant infos are logged via the SharedLogger 'ModuleLogger'
  • Module supports persistent data feature based on 'CSK_Module_PersistentData'
  • Module supports user management based on 'CSK_Module_UserManagement'
  • No open "ToDos" within the code or at least clearly explained comments why they exist...
  • "Version" key in app manifest was updated following semantic versioning (and use '0.x.y' for test / experimental modules which are not yet ready to be officially released)
  • Meaningful IDs used for UI elements
  • Module was tested on an AppSpace device (at least on SICK AppEngine) with no error message
  • README.md is up to date (incl. info of device + firmware the module was tested with)
  • CHANGELOG.md is up to date

golluroSICKAG and others added 10 commits August 14, 2024 15:50
@golluroSICKAG
# Release 2.0.0
ea1e20c 
## New features
- Supports FlowConfig feature to provide incoming MQTT messages / push messages to MQTT broker
- Provide version of module via 'OnNewStatusModuleVersion'
- Check if features of module can be used on device and provide this via 'OnNewStatusModuleIsActive' event / 'getStatusModuleActive' function
- New event 'OnNewConnectionStatus'
- Function 'getParameters' to provide PersistentData parameters
- Function to 'resetModule' to default setup

## Improvements
- New UI design available (e.g. selectable via CSK_Module_PersistentData v4.1.0 or higher), see 'OnNewStatusCSKStyle'
- 'loadParameters' returns its success
- 'sendParameters' can control if sent data should be saved directly by CSK_Module_PersistentData
- Changed log level of some messages from 'info' to 'fine'
- Added UI icon and browser tab information

## Bugfix
- Module tried to reconnect to MQTT broker every 5sec after a disconnection even it already reconnected succesfully
- Typo in code regarding password variable for credentials
- Typo in code regarding client certificate key path
@golluroSICKAG
- Update of UI settings
724a815
@teplymaSICKAG
Added event description for external use in UI in case of subscription
775969c
@golluroSICKAG
Merge pull request #1 from teplymaSICKAG/main
0453df4 
Added event description for external use in UI in case of subscription
@golluroSICKAG
- Fixed issues of review
f397c9d
@golluroSICKAG
- Removing navigation bar entries
dca2e85
@golluroSICKAG
Merge branch 'SICKAppSpaceCodingStarterKit:main' into main
e574538
@golluroSICKAG
# Release 2.1.0
2da90d9 
## New features
- Optionally set global prefix for all topics
- Optionally deactivate logging of communication to reduce CPU load
- Check if persistent data to load provides all relevant parameters. Otherwise add default values

## Improvements
- Check if client is connected to broker before trying to publish
@golluroSICKAG
# Release 2.2.0
dd0185d 
## New features
- Optionally send a BirthMessage if connected to MQTT broker

## Bugfix
- Did not use topic prefix for WillMessage
- Did not update topic prefix / status if WillMessage is active within UI
- Legacy bindings of ValueDisplay elements within UI did not work if deployed with VS Code AppSpace SDK
- UI differs if deployed via Appstudio or VS Code AppSpace SDK
- Fullscreen icon of iFrame was visible
@golluroSICKAG
changed release version
b85c875
kogliinSICKAG
kogliinSICKAG approved these changes May 15, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@kogliinSICKAG kogliinSICKAG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested the GUI with AppStudio, no obvious bugs found.
Some minor improvements committed via WebEx directly.

@golluroSICKAG golluroSICKAG merged commit f7eebd3 into SICKAppSpaceCodingStarterKit:main May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kogliinSICKAG kogliinSICKAG kogliinSICKAG approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@golluroSICKAG @kogliinSICKAG @teplymaSICKAG