control/json/zone.hpp

47  * a number of fans together to be under the same target control. These
79      * @brief Get the poweron target
81      * Poweron target is the target the fans within this zone should be set to
84      * @return Poweron target of this zone
94      * Default ceiling is the highest target the fans within this zone is
108      * The default floor is the lowest target the fans within this zone
123      * to a target are delayed before being made. The default is 0, which
125      * a change to the target.
142      * within the zone are decreased if events exist that result in a target
153      * @brief Get the current target of the zone
155      * @return - The current target of the zone
163      * @brief Get the target increase delta
165      * @return - The current target increase delta
173      * @brief Get the target decrease delta
175      * @return - The current target decrease delta
212      * Sets all fans in the zone to the target given when the zone is active
214      * @param[in] target - Target for fans
216     void setTarget(uint64_t target);
219      * Add a target lock for the specified fan.
221      * @param[in] fname - Fan to request/add the target lock
222      * @param[in] target - Target to register
224     void lockFanTarget(const std::string& fname, uint64_t target);
227      * Remove target lock for specific fan.
230      * @param[in] target- Target to de-register
232     void unlockFanTarget(const std::string& fname, uint64_t target);
235      * Sets and holds all fans in the zone to the target given or releases a
236      * target hold resulting in the fans being held at the highest remaining
237      * hold target if other hold targets had been requested. When no hold
240      * @param[in] ident - Unique identifier for a target hold
241      * @param[in] target - Target to hold fans at
242      * @param[in] hold - Whether to hold(true) or release(false) a target hold
244     void setTargetHold(const std::string& ident, uint64_t target, bool hold);
247      * @brief Set the floor to the given target and increase target to the floor
248      * when the target is below the floor value when floor changes are allowed.
250      * @param[in] target - Target to set the floor to
252     void setFloor(uint64_t target);
255      * Sets and holds the floor of the zone to the target given or releases a
257      * hold target if other floor hold targets had been requested. When no hold
261      * @param[in] target - Floor value
264     void setFloorHold(const std::string& ident, uint64_t target, bool hold);
310      * @brief Calculate the requested target from the given delta and increases
313      * @param[in] targetDelta - The delta to increase the target by
319      * processing of requested target increases while fans are increasing
324      * @brief Calculate the lowest requested decrease target from the given
327      * @param[in] targetDelta - The delta to decrease the target by
333      * requested target decreases if allowed
338      * @brief Set the requested target base to be used as the target to base a
339      * new requested target from
341      * @param[in] targetBase - Base target value to use
433     /* The zone's poweron target value for fans */
448     /* The floor target to not go below */
451     /* Target for this zone */
460     /* The ceiling target to not go above */
463     /* Requested target base */
478     /* The target increase timer object */
481     /* The target decrease timer object */
484     /* Map of target holds by a string identifier */
505      * @brief Parse and set the zone's poweron target value
509      * Sets the poweron target value for the zone from the JSON configuration
527      * @brief Get the request target base if defined, otherwise the the current
528      * target is returned
530      * @return - The request target base or current target