USBCommands.h

/*
 * Copyright (c) 2016 Jari Saukkonen
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef USBCOMMANDS_H
#define USBCOMMANDS_H

enum USBCommand {
    END = 0x00,
    IDENTIFY = 0x01,
    GETFACTORYSETTINGS = 0x02,
    GETOUTPUTSETTINGS = 0x03,
    GETSTATUS = 0x04,
    GETRAWPOWERUSAGE = 0x05,
    SETRELAY = 0x10,
    SETPWMDUTY = 0x11,
    RESETFUSE = 0x12,
    CONFIGUREOUTPUT = 0x13,
    CONFIGURESETTINGS = 0x14,

    FACTORYRESET = 0xFA,
    REBOOT_BOOTLOADER = 0xFB,
    CALIBRATEOUTPUT = 0xFC
};

struct GetFactorySettingsResponse {
    uint16_t firmwareVersion;
    uint16_t serialNumber;
    uint8_t fuseDelay;
    uint8_t skyQualityOffset;
    uint8_t features;
    uint8_t boardRevision;
} __attribute__((__packed__));

struct FactoryResetCommand {
    uint16_t serial;
    uint16_t r6ohms;
    uint16_t r7ohms;
    uint8_t boardRevision;
} __attribute__((__packed__));

struct GetOutputSettingsCommand {
    uint8_t outputNumber;
} __attribute__((__packed__));

struct GetOutputSettingsResponse {
    char name[16];
    uint8_t fuseCurrent;
    uint8_t type;
} __attribute__((__packed__));

struct GetStatusResponse {
    uint8_t relayIsOpenBits; // 1 = enabled, 0 = disabled
    uint8_t fuseIsBlownBits; // 1 = blown, 0 = not blown
    uint8_t pwmPercentages[6]; // 0-100
    uint8_t inputVoltage; // *10, 120 = 12.0V
    uint8_t outputPower[6]; // *10, 50 = 5.0A
    uint8_t numberOfTemperatureProbes;
    int16_t temperatureProbes[4]; // *10, -35 = -3.5 degrees Celsius
    int16_t temperature; // *10, -35 = -3.5 degrees Celsius
    int16_t dewpoint; // *10, -35 = -3.5 degrees Celsius
    uint8_t humidity; // 0-100 (%)
    uint16_t pressure; // *10, 10005 = 1000.5 hPa
    uint8_t skyquality; // *10, 210 = 21.0 mag/arcsec^2
    int16_t skytemperature; // *10, -35 = -3.5 degrees Celsius
    int16_t skyambienttemperature; // *10, -35 = -3.5 degrees Celsius
    uint8_t pthpresent; // 1 = pth sensor (BME280) present, 0 = absent
    uint8_t skyqualitypresent; // 1 = sky quality sensor present, 0 = absent
    uint8_t skytemperaturepresent; // 1 = sky temperature present, 0 = absent
    uint32_t skyqualityfreq; // raw sky quality frequency, *10, 35 = 3.5 Hz
} __attribute__((__packed__));

struct GetRawPowerUsageResponse {
    uint16_t rawValues[8];
} __attribute__((__packed__));

struct UpdateSettingsCommand {
    uint8_t features;
    uint8_t SkyQualityzeropoint;
    uint8_t fusespeed;
} __attribute__((__packed__));

struct SetRelayCommand {
    uint8_t outputNumber;
    uint8_t enabled;
} __attribute__((__packed__));

struct SetPwmDutyCommand {
    uint8_t outputNumber;
    uint8_t duty; // 0-100
} __attribute__((__packed__));

struct ResetFuseCommand {
    uint8_t outputNumber;
} __attribute__((__packed__));

struct ConfigureOutputCommand {
    uint8_t outputNumber;
    uint8_t outputType;
    uint8_t fuseCurrent;
    char name[16];
} __attribute__((__packed__));

struct ConfigureSettingsCommand {
    uint8_t fuseDelay;
    uint8_t skyQualityOffset;
    uint8_t featureTempProbe;
    uint8_t featureSkyQuality;
    uint8_t featureAmbientPTH;
    uint8_t featureSkyTemperature;
} __attribute__((__packed__));

struct CalibrateOutputCommand {
    uint8_t outputNumber;
    int8_t a;
    uint8_t b;
    uint8_t c;
} __attribute__((__packed__));

#endif