DH Modes: Documentation of Modes #84

New Issue

gaisser · 2020-05-25T12:43:57+02:00

gaisser commented

2020-05-25 12:43:57 +02:00

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

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.