Wiicom API Lib
 Tutto Strutture dati File Funzioni Variabili Ridefinizioni di tipo (typedef) Tipi enumerati (enum) Valori del tipo enumerato Definizioni Gruppi
Riferimenti per il file C:/WIICOM-SVN/Sviluppo/Software/library/wiicom_lib/trunk/wiicom_libutil.h

Wiicom Virtucal com port library. Continua...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdint.h>
#include <errno.h>
#include <unistd.h>

Vai al codice sorgente di questo file.

Definizioni

#define FALSE   0
 
#define TRUE   1
 
#define WIICOM_EWINSOCKETFAILURE   -1
 
#define WIICOM_ESOCKETCONNTIMEOUT   -2
 
#define WIICOM_ESOCKETRECVTIMEOUT   -3
 
#define WIICOM_EADDDATABLOCK   -4
 
#define WIICOM_EGETDATABLOCK   -5
 
#define WIICOM_EELABCOMM_MSG   -6
 
#define WIICOM_EVCPBAUD   -7
 
#define WIICOM_EVCPDATASIZE   -8
 
#define WIICOM_EVCPATTR   -9
 
#define WIICOM_EVCPPARITY   -10
 
#define WIICOM_ESETCMP_ALIAS   -11
 
#define WIICOM_ESETCMP_NET   -12
 
#define WIICOM_ESETCMP_UART   -13
 
#define WIICOM_ENOTSUPPORTED   -14
 
#define WIICOM_N_ERRNO   -15
 

Funzioni

void wiicom_util_perror (const char *string)
 Function that prints to stderr the description of the last error found. Continua...
 
const char * wiicom_util_strerror (int16_t par_errnum)
 Function that returns the description for the error number passed as a parameter. Continua...
 
void wiicom_util_set_errno (int32_t par_errnum)
 Function that sets the errno in the system error handling. Continua...
 
int32_t wiicom_util_get_errno ()
 Function that returns the last errno reported. Continua...
 
void wiicom_util_set_err_msg (const char *string)
 Function that override the error description returned by wiicom_util_perror. Continua...
 
uint8_t wiicom_util_isBigEndianSystem ()
 Function that checks if the system is Big Endian. Continua...
 
uint16_t wiicom_util_endianU16Conversion (uint16_t word)
 Function that reverses the order of the bytes of a uint16_t. Continua...
 
uint32_t wiicom_util_endianU32Conversion (uint32_t dword)
 Function that reverses the order of the bytes of a uint32_t. Continua...
 
uint16_t wiicom_util_CRC16 (uint8_t *msgByte, uint16_t msgByteLength)
 Function that computes CRC16 (standard Modbus CRC) of a sequence of bytes. Continua...
 
uint16_t wiicom_util_walkingCRC16 (uint8_t msgByte, uint8_t msgStart)
 Function that calculates the CRC16 (standard Modbus CRC) of a sequence of bytes using only one byte of that sequence and its position. Continua...
 
void wiicom_util_sleep (uint32_t millisec)
 Function that stop program execution for a number of milliseconds. Continua...
 

Descrizione dettagliata

Wiicom Virtucal com port library.

Generic library for error handling, data conversion and calculation of CRC16 (Modbus standard CRC)

Autore
Marco Malano
WIICOM s.r.l
Versione
1.0.1
Data
2012
Nota
None.

Documentazione delle funzioni

uint16_t wiicom_util_CRC16 ( uint8_t *  msgByte,
uint16_t  msgByteLength 
)

Function that computes CRC16 (standard Modbus CRC) of a sequence of bytes.

Parametri
[in]msgByteSequence of bytes on which you want to calculate the CRC16
[in]msgByteLengthNumber of bytes on which you want to calculate the CRC16
Restituisce
CRC16 of a sequence of bytes
uint16_t wiicom_util_endianU16Conversion ( uint16_t  word)

Function that reverses the order of the bytes of a uint16_t.

Parametri
[in]wordThe number to convert
Restituisce
Number with the bytes reversed
uint32_t wiicom_util_endianU32Conversion ( uint32_t  dword)

Function that reverses the order of the bytes of a uint32_t.

Parametri
[in]dwordThe number to convert
Restituisce
Number with the bytes reversed
int32_t wiicom_util_get_errno ( )

Function that returns the last errno reported.

Restituisce
void
uint8_t wiicom_util_isBigEndianSystem ( )

Function that checks if the system is Big Endian.

Restituisce
TRUE if Big Endian, Little Endian if FALSE
void wiicom_util_perror ( const char *  string)

Function that prints to stderr the description of the last error found.

Parametri
[in]stringText to prepend to the error description
Restituisce
void
void wiicom_util_set_err_msg ( const char *  string)

Function that override the error description returned by wiicom_util_perror.

Parametri
[in]stringstring to be used for overwriting
Restituisce
void
void wiicom_util_set_errno ( int32_t  par_errnum)

Function that sets the errno in the system error handling.

Parametri
[in]par_errnumError number to set
Restituisce
void
void wiicom_util_sleep ( uint32_t  millisec)

Function that stop program execution for a number of milliseconds.

Parametri
[in]numberof milliseconds
Restituisce
void
const char* wiicom_util_strerror ( int16_t  par_errnum)

Function that returns the description for the error number passed as a parameter.

Parametri
[in]par_errnumError number you want to have the description
Restituisce
string containing the error description
uint16_t wiicom_util_walkingCRC16 ( uint8_t  msgByte,
uint8_t  msgStart 
)

Function that calculates the CRC16 (standard Modbus CRC) of a sequence of bytes using only one byte of that sequence and its position.

Parametri
[in]msgByteByte on which you want to calculate the CRC16
[in]msgStartByte position within the sequence of bytes
Restituisce
CRC16 calculates