DigIO.h

Go to the documentation of this file.

/************************************************
 *
 *  CROSSCONTROL AUX API
 *
 *  DigIO.h
 *
 *  Version 2.15.2.0, 2020-07-08
 *
 *  (c) CrossControl 2010-2020
 *

 *  File description: 
 *  Read digital inputs
 *
 *  Use the function GetDigIO() to get a handle to pass on to the other functions. 
 *  Use the method DigIO_release(DIGIOHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include digio_example.cpp
 *
 ************************************************/
#ifndef CC_DIGIO_H 
#define CC_DIGIO_H

#include "CCAuxErrors.h"
#include "CCPlatform.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* DIGIOHANDLE;

  const uint8_t DigitalIn_1 = (1 << 0);
  const uint8_t DigitalIn_2 = (1 << 1);
  const uint8_t DigitalIn_3 = (1 << 2);
  const uint8_t DigitalIn_4 = (1 << 3);

  EXTERN_C
    CCAUXDLL_API
    DIGIOHANDLE
    CCAUXDLL_CALLING_CONV
    GetDigIO(void);

  EXTERN_C
    CCAUXDLL_API
    void
    CCAUXDLL_CALLING_CONV
    DigIO_release(DIGIOHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    DigIO_getDigIO (DIGIOHANDLE, uint8_t* status);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    DigIO_setDigIO (DIGIOHANDLE, uint8_t state);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    DigIO_getDigPowerOutput(DIGIOHANDLE, PowerOutput output, CCStatus* enabled, uint8_t* status);


  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    DigIO_setDigPowerOutput(DIGIOHANDLE, PowerOutput output, CCStatus enabled);


#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_DIGIO_H */