Skip to content

Release 3.1.0#2

Merged
golluroSICKAG merged 9 commits intoSICKAppSpaceCodingStarterKit:mainfrom
golluroSICKAG:main
Mar 14, 2025
Merged

Release 3.1.0#2
golluroSICKAG merged 9 commits intoSICKAppSpaceCodingStarterKit:mainfrom
golluroSICKAG:main

Conversation

@golluroSICKAG
Copy link
Copy Markdown
Contributor

Release 3.1.0

Improvements

  • Automatically start image provider after 3 seconds if used within FlowConfig
  • React on "OnStopFlowConfigProviders" event of FlowConfig module to stop provider
  • Optionally setup image path, type and cycle time within FlowConfig block
  • Prevent changing of image type if player is currently active

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

## New features
- Supports FlowConfig feature to forward loaded images
- Provide version of module via 'OnNewStatusModuleVersion'
- Function 'getParameters' to provide PersistentData parameters
- Check if features of module can be used on device and provide this via 'OnNewStatusModuleIsActive' event / 'getStatusModuleActive' function
- Function to 'resetModule' to default setup
- Provide new images in /resources

## Improvements
- Provide available folders auto suggestion in UI
- 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
- Added FlowConfigPriority to stop player if new flow is activated
### Improvements
- Automatically start image provider after 3 seconds if used within FlowConfig
- React on "OnStopFlowConfigProviders" event of FlowConfig module to stop provider
- Optionally setup image path, type and cycle time within FlowConfig block
- Prevent changing of image type if player is currently active
@vasudarSICKAG
Copy link
Copy Markdown

Tested and reviewed. Thanks

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants