phosphor-fan-presence/presence/json_parser.hpp

4 #include "fan.hpp"
19 namespace fan  namespace
34 using fanPolicy = std::tuple<Fan, std::vector<std::unique_ptr<PresenceSensor>>>;
61      * @brief Get the json config based fan presence policies
63      * @return - The fan presence policies
78      * @brief Parses and populates the fan presence policies from
85     /* Fan presence policies */
91     /* List of Fan objects to have presence policies */
114      * @brief Process the json config to extract the defined fan presence
122      * @brief Get the redundancy policy of presence detection for a fan
125      * @param[in] fpolicy - fan policy object
128      * @return - The constructed redundancy policy type for the fan
136  * Methods of fan presence detection function declarations
141  * @brief Fan presence detection method by tach feedback
143  * @param[in] fanIndex - fan object index to add tach method
146  * @return - A presence sensor to detect fan presence by tach feedback
151  * @brief Fan presence detection method by gpio
153  * @param[in] fanIndex - fan object index to add gpio method
156  * @return - A presence sensor to detect fan presence by gpio
163  * Redundancy policies for fan presence detection function declarations
169  * sensors for a fan
171  * @param[in] fan - fan policy object with the presence sensors for the fan
177     const fanPolicy& fan, std::unique_ptr<EEPROMDevice> eepromDevice);
181  * sensors for a fan
183  * @param[in] fan - fan policy object with the presence sensors for the fan
189     const fanPolicy& fan, std::unique_ptr<EEPROMDevice> eepromDevice);
194 } // namespace fan