Mio.h

Go to the documentation of this file.

#ifndef Mio_h
#define Mio_h

#include "MioComm.h"


class Mio
{

public:


    Mio(
        );

    virtual ~Mio(
        );

    void SetReceiveTimeout(
        unsigned timeout_ms
        )
    {
        m_TimeoutMs = timeout_ms;
    }

    unsigned GetReceiveTimeout(
        ) const
    {
        return m_TimeoutMs;
    }

    void SetDrainTime(
        unsigned drain_time_ms
        )
    {
        m_DrainTimeMs = drain_time_ms;
    }

    unsigned GetDrainTime(
        ) const
    {
        return m_DrainTimeMs;
    }

    virtual const char * ResultCodeToText(
        Mio_Rc rc
        ) const;

    Mio_Rc Reset(
        );

    Mio_Rc Loopback(
        void * out_data,
        int & out_data_len,
        const void * in_data,
        int in_data_len
        );

    Mio_Rc SetMioPortsModes(
        const Mio_PortMode * modes,
        const unsigned char * params,
        const Mio_Port * ports,
        int num_ports
        );

    Mio_Rc SetMioPortMode(
        Mio_PortMode mode,
        unsigned char param,
        Mio_Port port
        )
    {
        return SetMioPortsModes(&mode, &param, &port, 1);
    }

    Mio_Rc GetMioPortsModes(
        Mio_PortMode * modes,
        unsigned char * params,
        const Mio_Port * ports,
        int num_ports
        );

    Mio_Rc GetMioPortMode(
        Mio_PortMode & mode,
        unsigned char & param,
        Mio_Port port
        )
    {
        return GetMioPortsModes(&mode, &param, &port, 1);
    }

    Mio_Rc SetDigitalOutputValue(
        unsigned char value,
        Mio_Port port
        );

    Mio_Rc GetDigitalInputValue(
        unsigned char & value,
        Mio_Port port
        );

    Mio_Rc SetDigitalOutputsValues(
        const unsigned char * values,
        const Mio_Port * ports,
        int num_ports
        );

    Mio_Rc GetDigitalInputsValues(
        unsigned char * values,
        const Mio_Port * ports,
        int num_ports
        );

    Mio_Rc GetAnalogInputsValues(
        int * values,
        const Mio_Port * ports,
        int num_ports
        );

    Mio_Rc GetAnalogInputValue(
        int & value,
        Mio_Port port
        )
    {
        return GetAnalogInputsValues(&value, &port, 1);
    }

    Mio_Rc StartDS18x20Task(
        int task_id,
        Mio_Port mio_port,
        Mio_DS18x20Type sensor_type,
        unsigned conversion_time_x100ms
        );

    Mio_Rc GetDS18x20TaskTemperature(
        int & temperature,
        unsigned char & sn,
        Mio_DS18x20Error & error,
        int task_id
        );

    Mio_Rc StopTask(
        int task_id
        );

    struct PWMOutSubchannelConfig
    {
        int config;

        int width;
    };

    struct PWMOutSubchannelConfig2
    {
        int config;

        float duty;
    };

    static Mio_Rc ConvertPWMOutValues(
        Mio_PWMClockSpeed & pwm_clock_speed,
        int & pwm_period,
        PWMOutSubchannelConfig dst_subchannels[3],
        float pwm_frequency,
        const PWMOutSubchannelConfig2 src_subchannels[3]
        );

    Mio_Rc StartPWMOut(
        int pwm_clock_channel,
        Mio_PWMClockSpeed pwm_clock_speed,
        int pwm_period,
        const PWMOutSubchannelConfig subchannels[3]
        );

    Mio_Rc StartPWMOut(
        int pwm_clock_channel,
        float pwm_frequency,
        const PWMOutSubchannelConfig2 subchannels[3]
        );

    Mio_Rc AdjustPWMOut(
        int pwm_clock_channel,
        Mio_PWMClockSpeed pwm_clock_speed,
        int pwm_period,
        const PWMOutSubchannelConfig subchannels[3]
        );

    Mio_Rc AdjustPWMOut(
        int pwm_clock_channel,
        float pwm_frequency,
        const PWMOutSubchannelConfig2 subchannels[3]
        );


    struct PWMInSubchannelConfig
    {
        int config;

        int edges;
    };

    Mio_Rc StartPWMIn(
        int pwm_clock_channel,
        const PWMInSubchannelConfig subchannels[4]
        );

    Mio_Rc SetPWMInMode(
        int pwm_clock_channel,
        int pwm_subchannel,
        Mio_PWMInMode mode
        );

    Mio_Rc GetPWMInResult(
        unsigned & total_halfperiod_time,
        unsigned & total_period_time,
        int & edges_captured,
        int pwm_clock_channel,
        int pwm_subchannel
        );

    Mio_Rc StopPWM(
        int pwm_clock_channel
        );


protected:


    virtual Mio_Rc ResetCommunicationPort(
        ) = 0;

    virtual Mio_Rc SendRawDataToMio(
        const void * data,
        int data_len
        ) = 0;

    virtual Mio_Rc ReceiveRawDataFromMio(
        void * data,
        int data_len,
        int & data_bytes_received,
        unsigned timeout_ms
        ) = 0;

    virtual unsigned GetCurrentTimeMs(
        ) = 0;

    virtual unsigned GetElapsedTimeMs(
        unsigned start_time
        ) = 0;

    virtual void DispatchOutOfBandMessage(
        Mio_MioMsgId msg_id,
        int payload_len,
        const void * payload
        )
    {
        // Do nothing by default
    }


private:


    static bool CorrectableWithRetransmission(
        Mio_Rc rc
        );

    void DrainBadMessage(
        );

    Mio_Rc SendMessage(
        Mio_HostMsgId msg_id,
        const void * payload,
        int payload_len
        );

    Mio_Rc ReceiveMessage(
        Mio_MioMsgId & msg_id,
        bool & out_of_band,
        int & payload_len,
        void * payload,
        unsigned timeout_ms
        );

    Mio_Rc ReceiveSpecificMessage(
        Mio_MioMsgId msg_id,
        int & payload_len,
        void * payload
        );

    Mio_Rc ReceiveSpecificMessage(
        Mio_MioMsgId msg_id,
        void * payload = 0,
        int payload_len = 0
        );

    Mio_Rc SendAndReceiveSpecificMessage(
        Mio_HostMsgId send_msg_id,
        const void * send_payload,
        int send_payload_len,
        Mio_MioMsgId receive_msg_id,
        int & received_payload_len,
        void * received_payload
        );

    Mio_Rc SendAndReceiveSpecificMessage(
        Mio_HostMsgId send_msg_id,
        const void * send_payload,
        int send_payload_len,
        Mio_MioMsgId receive_msg_id,
        void * received_payload = 0,
        int receive_payload_len = 0
        );

    Mio_Rc StartTask(
        int task_id,
        Mio_TaskType task_type,
        const void * task_config,
        int task_config_len
        );


    unsigned m_TimeoutMs;

    unsigned m_DrainTimeMs;

};


#endif // Mio_h

---