add class comment

This commit is contained in:
Siwat Sirichai 2024-01-01 01:56:49 +07:00
parent 039e65e6df
commit 4031b7555a
9 changed files with 159 additions and 1 deletions

View file

@ -54,6 +54,15 @@ struct AirConditioner {
};
// This requires 3 bytes of FRAM
/**
* @brief The ClimateCard class is a class for controlling an air conditioner
*
* This class allows you to control an air conditioner using an IR LED.
* It is meant to be used with the ESPMega Climate Card.
*
* @note You can also use a DHT22 or DS18B20 temperature sensor to get the room temperature (and humidity if using a DHT22). Although, this is optional.
*
*/
class ClimateCard : public ExpansionCard {
public:
ClimateCard(uint8_t ir_pin, AirConditioner ac, uint8_t sensor_type, uint8_t sensor_pin);