pegasus_upb3.h

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2026 Jasem Mutlaq. All rights reserved.
 
  Pegasus Ultimate Power Box V3 Driver.
 
  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 2 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.
 
  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
 
  The full GNU General Public License is included in this distribution in the
  file called LICENSE.
*******************************************************************************/
 
#pragma once
 
#include "defaultdevice.h"
#include "indifocuserinterface.h"
#include "indiweatherinterface.h"
#include "indipowerinterface.h"
#include "indioutputinterface.h"
#include <stdint.h>
 
namespace Connection
{
class Serial;
}
 
class PegasusUPB3 : public INDI::DefaultDevice,
    public INDI::FocuserInterface,
    public INDI::WeatherInterface,
    public INDI::PowerInterface,
    public INDI::OutputInterface
{
    public:
        PegasusUPB3();
 
        virtual bool initProperties() override;
        virtual bool updateProperties() override;
 
        virtual bool ISNewNumber(const char *dev, const char *name, double values[], char *names[], int n) override;
        virtual bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n) override;
        virtual bool ISNewText(const char *dev, const char *name, char *texts[], char *names[], int n) override;
 
    protected:
        const char *getDefaultName() override;
        virtual bool saveConfigItems(FILE *fp) override;
 
        // Event loop
        virtual void TimerHit() override;
 
        // Focuser Overrides
        virtual IPState MoveAbsFocuser(uint32_t targetTicks) override;
        virtual IPState MoveRelFocuser(FocusDirection dir, uint32_t ticks) override;
        virtual bool AbortFocuser() override;
        virtual bool ReverseFocuser(bool enabled) override;
        virtual bool SyncFocuser(uint32_t ticks) override;
        virtual bool SetFocuserBacklash(int32_t steps) override;
        virtual bool SetFocuserBacklashEnabled(bool enabled) override;
 
        // Weather Overrides
        virtual IPState updateWeather() override
        {
            return IPS_OK;
        }
 
        // Power Interface Overrides
        virtual bool SetPowerPort(size_t port, bool enabled) override;
        virtual bool SetDewPort(size_t port, bool enabled, double dutyCycle) override;
        virtual bool SetVariablePort(size_t port, bool enabled, double voltage) override;
        virtual bool SetLEDEnabled(bool enabled) override;
        virtual bool SetAutoDewEnabled(size_t port, bool enabled) override;
        virtual bool CyclePower() override;
        virtual bool SetUSBPort(size_t port, bool enabled) override;
 
        // Output Interface Overrides (Relay)
        virtual bool UpdateDigitalOutputs() override;
        virtual bool CommandOutput(uint32_t index, OutputState command) override;
 
    private:
        bool Handshake();
 
        // Get Data
        bool setupParams();
        bool sendFirmware();
        bool getSensorData();
        bool getPowerData();
        bool getStepperData();
        bool getAutoDewData();
        bool getUSBStatus();
        bool getInputVoltageCurrentData();
        bool getEnvironmentalData();
        std::vector<std::string> split(const std::string &input, const std::string &regex);
 
        // Device Control
        bool reboot();
 
        // Power
        bool setPowerEnabled(uint8_t port, uint8_t value);
        bool setPowerLEDEnabled(bool enabled);
        bool setPowerOnBoot();
        bool getPowerOnBoot();
 
        // Adjustable Outputs (Buck and Boost)
        bool setBuckVoltage(uint8_t voltage);
        bool setBoostVoltage(uint8_t voltage);
        bool setBuckEnabled(bool enabled);
        bool setBoostEnabled(bool enabled);
 
        // Dew
        bool setAutoDewEnabled(uint8_t port, bool enabled);
        bool setAutoDewAgg(uint8_t value);
        bool setDewPWM(uint8_t id, uint8_t value);
 
        // USB
        bool setUSBPortEnabled(uint8_t port, bool enabled);
 
        // Relay
        bool setRelay(bool enabled);
 
        // Focuser
        bool setFocuserMaxSpeed(uint16_t maxSpeed);
        bool setFocuserMicrostepping(uint8_t value);
        bool setFocuserCurrentLimit(uint16_t value);
        bool setFocuserHoldTorque(bool enabled);
 
        bool sendCommand(const char *cmd, char *res);
 
        void cleanupResponse(char *response);
 
        bool sensorUpdated(const std::vector<std::string> &result, uint8_t start, uint8_t end);
 
        bool stepperUpdated(const std::vector<std::string> &result, uint8_t index);
 
        int PortFD { -1 };
        bool setupComplete { false };
 
        Connection::Serial *serialConnection { nullptr };
 
        INDI::PropertySwitch RebootSP {1};
 
        // Power Consumption
        INDI::PropertyNumber PowerConsumptionNP {3};
        enum
        {
            CONSUMPTION_AVG_AMPS,
            CONSUMPTION_AMP_HOURS,
            CONSUMPTION_WATT_HOURS,
        };
 
        // Select which power is ON on bootup
        INDI::PropertySwitch PowerOnBootSP {6};
        enum
        {
            POWER_PORT_1,
            POWER_PORT_2,
            POWER_PORT_3,
            POWER_PORT_4,
            POWER_PORT_5,
            POWER_PORT_6
        };
 
        // Overcurrent status
        INDI::PropertyLight OverCurrentLP {9};
        enum
        {
            OC_POWER_1,
            OC_POWER_2,
            OC_POWER_3,
            OC_POWER_4,
            OC_POWER_5,
            OC_POWER_6,
            OC_DEW_1,
            OC_DEW_2,
            OC_DEW_3
        };
 
        // Auto Dew Aggressiveness (Global)
        enum
        {
            AUTO_DEW_AGG,
        };
        INDI::PropertyNumber AutoDewAggNP {1};
 
        // Auto Dew Aggressiveness per Port
        INDI::PropertyNumber AutoDewAggPerPortNP {3};
        enum
        {
            AUTO_DEW_AGG_1,
            AUTO_DEW_AGG_2,
            AUTO_DEW_AGG_3
        };
 
        // Focuser settings
        INDI::PropertyNumber FocuserSettingsNP {4};
        enum
        {
            SETTING_MAX_SPEED,
            SETTING_MICROSTEPPING,
            SETTING_CURRENT_LIMIT,
            SETTING_HOLD_TORQUE
        };
 
        INDI::PropertyText FirmwareTP {2};
        enum
        {
            FIRMWARE_VERSION,
            FIRMWARE_UPTIME
        };
 
        std::vector<std::string> lastSensorData, lastPowerData, lastStepperData, lastAutoDewData, lastVRData, lastESData;
        bool focusMotorRunning { false };
        bool m_RelayState { false };
        char stopChar { 0xD };
 
        static constexpr const uint8_t PEGASUS_TIMEOUT {3};
        static constexpr const char *ENVIRONMENT_TAB {"Environment"};
        static constexpr const char *POWER_TAB {"Power"};
        static constexpr const char *DEW_TAB {"Dew"};
        static constexpr const char *FIRMWARE_TAB {"Firmware"};
        static constexpr const char *RELAY_TAB {"Relay"};
};