hcl.h

Go to the documentation of this file.

//==============================================================================
//
//      hcl.h - Seiko Epson Hardware Control Library
//
//      This layer of indirection is added to allow the sample code to call
//  generic     functions to work on multiple hardware platforms
//
//
//  THE SOFTWARE IS RELEASED INTO THE PUBLIC DOMAIN.
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  NONINFRINGEMENT, SECURITY, SATISFACTORY QUALITY, AND FITNESS FOR A
//  PARTICULAR PURPOSE. IN NO EVENT SHALL EPSON BE LIABLE FOR ANY LOSS, DAMAGE
//  OR CLAIM, ARISING FROM OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF THE
//  SOFTWARE.
//
//==============================================================================

#pragma once

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdio.h>

#ifndef OK
#define OK (1)
#endif

#ifndef NG
#define NG (0)
#endif

#define FATAL                                                          \
  do {                                                                 \
    fprintf(stderr, "Error at line %d, file %s (%d) [%s]\n", __LINE__, \
            __FILE__, errno, strerror(errno));                         \
    exit(1);                                                           \
  } while (0)

/*****************************************************************************
** Function name:       seInit
** Description:         Initialize the Seiko Epson Hardware Control Library
** Parameters:          None
** Return value:        OK or NG
*****************************************************************************/
int seInit(void);

/*****************************************************************************
** Function name:       seRelease
** Description:         De-initialize the Seiko Epson Hardware Control Library
** Parameters:          None
** Return value:        OK or NG
*****************************************************************************/
int seRelease(void);

/*****************************************************************************
** Function name:       seDelayMS
** Description:         Delay main application thread execution by at least
**                      the requested number of MilliSeconds
** Parameters:          uint32_t milliseconds
** Return value:        None
*****************************************************************************/
void seDelayMS(uint32_t millis);

/*****************************************************************************
** Function name:       seDelayMicroSecs
** Description:         Delay main application thread execution by at least
**                      the requested number of Microseconds
** Parameters:          uint32_t microseconds
** Return value:        None
*****************************************************************************/
void seDelayMicroSecs(uint32_t micros);

#ifdef __cplusplus
}
#endif