fsfw/fsfw
fsfw/fsfw
11
3
Fork 6
Code Issues 32 Pull Requests 4 Releases 10 Wiki Activity

DH Modes: Documentation of Modes #84

New Issue
Open
opened 2020-05-25 12:43:57 +02:00 by gaisser · 1 comment
gaisser commented 2020-05-25 12:43:57 +02:00
Owner
Copy Link
  • The current Documentation of Transition Modes is unclear in most cases for a developer.
  • Improve the Documentation of "doStartUp". Why can the developer leave this function with MODE_ON or _MODE_TO_ON. Does the developer need to set transition modes if commanded to _MODE_TO_ON? Does the developer need to call doTransition by himself in "doStartUp"?
  • Why is MODE_OFF to MODE_NORMAL not allowed? Documentation seems to be missing.
  • Difference between TRANSITION_MODE_CHILD_ACTION_MASK and TRANSITION_MODE_BASE_ACTION_MASK.
  • Developers are confused when to set a transition mode and when to set the final mode. Maybe, we could introduce the policy that final modes are set by DHB when doTransition signals a finished transition?
* The current Documentation of Transition Modes is unclear in most cases for a developer. * Improve the Documentation of "doStartUp". Why can the developer leave this function with MODE_ON or \_MODE_TO_ON. Does the developer need to set transition modes if commanded to \_MODE_TO_ON? Does the developer need to call doTransition by himself in "doStartUp"? * Why is MODE_OFF to MODE_NORMAL not allowed? Documentation seems to be missing. * Difference between TRANSITION_MODE_CHILD_ACTION_MASK and TRANSITION_MODE_BASE_ACTION_MASK. * Developers are confused when to set a transition mode and when to set the final mode. Maybe, we could introduce the policy that final modes are set by DHB when doTransition signals a finished transition?
gaisser added the
Documentation
 label 2020-05-25 12:43:57 +02:00
gaisser added the
feature
 label 2020-05-25 12:55:49 +02:00
muellerr commented 2020-05-26 16:11:14 +02:00
Owner
Copy Link

MIstake found in buildTransitionDeviceCommand()

	/**
	 * Build the device command to send for a transitional mode.
	 *
	 * This is only called in @c _MODE_TO_NORMAL, @c _MODE_TO_ON, @c _MODE_TO_RAW,
	 * @c _MODE_START_UP and @c _MODE_TO_POWER_DOWN. So it is used by doStartUp()
	 * and doShutDown() as well as doTransition()

I think its _MODE_SHUT_DOWN instead of _MODE_TO_POWER_DOWN. Fixed in pull request #44

MIstake found in buildTransitionDeviceCommand() ```cpp /** * Build the device command to send for a transitional mode. * * This is only called in @c _MODE_TO_NORMAL, @c _MODE_TO_ON, @c _MODE_TO_RAW, * @c _MODE_START_UP and @c _MODE_TO_POWER_DOWN. So it is used by doStartUp() * and doShutDown() as well as doTransition() ``` I think its _MODE_SHUT_DOWN instead of _MODE_TO_POWER_DOWN. Fixed in pull request #44
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
API Change
Changes the API, so Users need to adapted
Breaking API Change
Changes the API in a non backwards compatible way
bug
Something is not working
build
Issues related to the buildsystem, including CI
cosmetics
Small change most users won't notice
Documentation
Improvement of code documentation
duplicate
This issue or pull request already exists
feature
New feature
help wanted
Need some help
hotfix
Quick or important fix that is merged directly into master, causing a new revision
invalid
#worksforme
question
More information is needed
Refactor
Contains a refactoring of some code
Tests
Issues related to testing code
wontfix
This won't be fixed
No Label
Documentation
feature
Milestone
No items
No Milestone
Assignees
Clear assignees
ahinkel dwoodward gaisser hanke jenkins_buildfix lrajer meierj mohr muellerr taheran tbaumgartl
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: fsfw/fsfw#84
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?