Skip to content

# Release 3.0.0#1

Merged
golluroSICKAG merged 4 commits intoSICKAppSpaceCodingStarterKit:mainfrom
golluroSICKAG:main
Nov 28, 2024
Merged

# Release 3.0.0#1
golluroSICKAG merged 4 commits intoSICKAppSpaceCodingStarterKit:mainfrom
golluroSICKAG:main

Conversation

@golluroSICKAG
Copy link
Copy Markdown
Contributor

Version 3.0.0

New features

  • Supports FlowConfig feature to set images to process / provide results
  • 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

Improvements

  • New UI design available (e.g. selectable via CSK_Module_PersistentData v4.1.0 or higher), see 'OnNewStatusCSKStyle'
  • check if instance exists if selected
  • '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

  • Never deregistered from events

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 set images to process / provide results
- 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

## Improvements
- New UI design available (e.g. selectable via CSK_Module_PersistentData v4.1.0 or higher), see 'OnNewStatusCSKStyle'
- check if instance exists if selected
- '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
- Never deregistered from events
Copy link
Copy Markdown

@tarnamaSICKAG tarnamaSICKAG left a comment

Choose a reason for hiding this comment

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

Bei "Registered on image event" fehlt der Beispieltext ("CSK_ImagePlayer.OnNewImage)

Bei "Use Masking" active in Step 4, kleiner bug:
Die angezeigte ROI wird nicht von rectangle auf circle umgestellt wenn:

  • Circle als "mask type" ausgewählt ist
  • dann Reset Mask geklickt wird
  • dann wieder auf circle gegangen wird
    Danach muss man als Workaround "Mask Type" auf rectangle stellen und anschließend wieder auf circle.
    Rest sieht gut aus :)

Bugfix
- Error if module is not active but 'getInstancesAmount' was called
- processInstanceNUM did not work after deregistering from event to process images
@golluroSICKAG
Copy link
Copy Markdown
Contributor Author

Issues sould be fixed now.
Thx for the review.

@golluroSICKAG golluroSICKAG merged commit 75c7909 into SICKAppSpaceCodingStarterKit:main Nov 28, 2024
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