coincellhell.h

/* * Copyright (c) 2023 Carl Klemm <carl@uvos.xyz>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation and/or
 * other materials provided with the distribution.
 *  * Neither the name of %ORGANIZATION% nor the names of its contributors may be
 * used to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#pragma once
 
#include <stdint.h>
#include <semaphore.h>
#include <stdbool.h>
 
#include "usbcommands.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct coincellhell
{
        struct usbshm* priv;
};
 
struct heater_state
{
        bool enabled;
        bool ready;
        bool ramp;
        bool fault;
        fault_t faultType;
        uint8_t dacCommand;
        float setpoint;
 
        float rampTarget;
        time_t rampStartTime;
        time_t rampStopTime;
};
 
int coincellhell_connect(struct coincellhell* hell, uint16_t serial);
 
int coincellhell_get_temperature(struct coincellhell* hell, uint8_t heater, temperature_sensor_location_t location, float* temperature);
 
int coincellhell_set_temperature(struct coincellhell* hell, uint8_t heater, float temperature);
 
int coincellhell_get_temperature_setpoint(struct coincellhell* hell, uint8_t heater, float* temperature);
 
int coincellhell_get_state(struct coincellhell* hell, uint8_t heater, struct heater_state* state);
 
int coincellhell_set_enabled(struct coincellhell* hell, uint8_t heater, bool enabled);
 
int coincellhell_check_ready(struct coincellhell* hell, bool* ready);
 
int coincellhell_set_temperature_ramp(struct coincellhell* hell, uint8_t heater, time_t end_time, float temperature);
 
int coincellhell_cancle_ramp(struct coincellhell* hell, uint8_t heater);
 
int coincellhell_set_led(struct coincellhell* hell, bool on);
 
int coincellhell_reset(struct coincellhell* hell);
 
void coincellhell_disconnect(struct coincellhell* hell);
 
const char* coincellhell_string_for_fault(fault_t fault);
 
int coincellhell_write_eeprom(struct coincellhell* hell, uint16_t addr, uint16_t value);
uint16_t coincellhell_read_eeprom(struct coincellhell* hell, uint16_t addr);
uint8_t coincellhell_read_oscal(struct coincellhell* hell);
uint32_t coincellhell_get_seconds(struct coincellhell* hell);
const uint8_t* coincellhell_get_fw_git_revision(struct coincellhell* hell);
int coincellhell_enable_watchdog(struct coincellhell* hell);
int coincellhell_set_periodic_recal(struct coincellhell* hell, bool recal);
void coincellhell_reset_bus(struct coincellhell* hell);
 
#ifdef __cplusplus
}
#endif