Skip to content

# Release 2.0.0#2

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

# Release 2.0.0#2
golluroSICKAG merged 4 commits intoSICKAppSpaceCodingStarterKit:mainfrom
golluroSICKAG:main

Conversation

@golluroSICKAG
Copy link
Copy Markdown
Contributor

@golluroSICKAG golluroSICKAG commented Aug 14, 2024

Version 2.0.0

New features

  • Supports FlowConfig feature to set source to forward via HTTP request
  • 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

  • Added parameters to 'addRequest'-function
  • Added ENUMs for RequestMode
  • 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
  • Added UI icon and browser tab information

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
# Release 2.0.0
4cbd1cc 
## New features
- Supports FlowConfig feature to set source to forward via HTTP request
- 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
- Added parameters to 'addRequest'-function
- Added ENUMs for RequestMode
- 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
- Added UI icon and browser tab information
@golluroSICKAG
- Update of UI settings
1d8fd6c
vasudarSICKAG
vasudarSICKAG reviewed Sep 26, 2024
View reviewed changes
Comment thread docu/media/UI_Screenshot.png
vasudarSICKAG
vasudarSICKAG approved these changes Sep 26, 2024
View reviewed changes
Copy link
Copy Markdown

@vasudarSICKAG vasudarSICKAG left a comment

Choose a reason for hiding this comment

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

Reviewed and tested using SICK AppEngine.

@golluroSICKAG
- Fixed issues of review
cb6d7e3 
### New features
- Added 'Localhost' as interface to perform internal HTTP requests

### Bugfix
- Error if module is not active but 'getInstancesAmount' was called
@golluroSICKAG
Copy link
Copy Markdown
Contributor Author

golluroSICKAG commented Oct 14, 2024

Thx for the review!

@vasudarSICKAG
Copy link
Copy Markdown

vasudarSICKAG commented Oct 16, 2024

2nd review is done.

vasudarSICKAG
vasudarSICKAG reviewed Oct 16, 2024
View reviewed changes
Copy link
Copy Markdown

@vasudarSICKAG vasudarSICKAG left a comment

Choose a reason for hiding this comment

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

Thanks and ready for release.

@golluroSICKAG golluroSICKAG merged commit bba0b76 into SICKAppSpaceCodingStarterKit:main Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vasudarSICKAG vasudarSICKAG vasudarSICKAG 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.

2 participants

@golluroSICKAG @vasudarSICKAG