sb-py/include/volcano.h

/*
 * volcano.h
 *
 * Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * See <http://www.gnu.org/licenses/>.
 */

#ifndef __VOLCANO_H__
#define __VOLCANO_H__

#include <stdint.h>
#include <stdbool.h>

#include "models.h"

#define VOLCANO_FW_LEN 12

enum volcano_state {
    VOLCANO_STATE_NONE = 0,
    VOLCANO_STATE_HEATER = (1 << 0),
    VOLCANO_STATE_PUMP = (1 << 1),
    VOLCANO_STATE_INVALID = 0xFF,
};

// returns < 0 on error
int8_t volcano_discover_characteristics(bool wf, bool conf);

// in 1/10th degrees C, or < 0 on error
int16_t volcano_get_current_temp(void);
int16_t volcano_get_target_temp(void);

// v in 1/10th degrees C, returns < 0 on error
int8_t volcano_set_target_temp(uint16_t v);

// returns < 0 on error
int8_t volcano_set_heater_state(bool value);
int8_t volcano_set_pump_state(bool value);
int8_t volcano_set_unit(enum unit unit);
int8_t volcano_set_vibration(bool value);
int8_t volcano_set_display_cooling(bool value);

enum unit volcano_get_unit(void);
enum volcano_state volcano_get_state(void);

// returns bool, or < 0 on error
int8_t volcano_get_vibration(void);
int8_t volcano_get_display_cooling(void);

// returns seconds, or < 0 on error
int16_t volcano_get_auto_shutoff(void);

// v in seconds, returns < 0 on error
int8_t volcano_set_auto_shutoff(uint16_t v);

// returns 0 - 100, or < 0 on error
int8_t volcano_get_brightness(void);

// v in 0 - 100, returns < 0 on error
int8_t volcano_set_brightness(uint8_t v);

// val is filled with VOLCANO_FW_LEN bytes, returns < 0 on error
int8_t volcano_get_firmware(char *val);

// returns minutes, or < 0 on error
int32_t volcano_get_runtime(void);

#endif // __VOLCANO_H__