Kolibri library – API Documentation

Header image

Main page


Data Structures | Typedefs | Enumerations
Kolibri data types

Documentation of data types defined by the Kolibri library. More...

Data Structures

struct  KolibriUint64
 Unsigned 64-bit data type. More...
 
struct  KolibriSint64
 Signed 64-bit data type. More...
 
struct  KolibriByteArray
 Byte array data type. More...
 
union  KolibriAny
 Value of the data point in various data types. More...
 
struct  KolibriDataset
 Data set for data exchange. More...
 
struct  KolibriNodeProps
 Node properties. More...
 
struct  KolibriStats
 Statistical data. More...
 

Typedefs

typedef KolibriBool(* KolibriRpcServerCb) (void *context, json::Base **response, json::Obj *params)
 Type of callback function that is registered with the Kolibri RPC server. More...
 
typedef unsigned char KolibriBool
 Boolean data type. More...
 
typedef unsigned char KolibriUint8
 Unsigned 8-bit data type. More...
 
typedef signed char KolibriSint8
 Signed 8-bit data type. More...
 
typedef unsigned short KolibriUint16
 Unsigned 16-bit data type. More...
 
typedef signed short KolibriSint16
 Signed 16-bit data type. More...
 
typedef unsigned long KolibriUint32
 Unsigned 32-bit data type. More...
 
typedef signed long KolibriSint32
 Signed 32-bit data type. More...
 
typedef float KolibriFloat32
 32-bit floating point data type More...
 
typedef double KolibriFloat64
 64-bit floating point data type More...
 
typedef void const * KolibriHandle
 Datasets handle. More...
 
typedef void(* KolibriClockUpdateCb) (KolibriUint32 timestamp)
 Type of call-back function that can be registered through kolibriRegisterClockUpdateCb() More...
 
typedef void(* KolibriLogCb) (KolibriLogType type, char const *msg,...)
 Type of call-back function that can be registered through kolibriRegisterLogCb() More...
 
typedef void(* KolibriPublishCb) (KolibriBool unpublish, KolibriUint16 idx, char const *path, KolibriPointFlag flags, KolibriDataType dataType, KolibriTriggerMode triggerMode, KolibriAny triggerModeParamN, KolibriUint32 triggerModeParamT, KolibriUint8 triggerDomain, KolibriQos qos)
 Type of call-back function that can be registered through kolibriRegisterPublishCb() More...
 
typedef void(* KolibriPublishCompleteCb) (void)
 Type of call-back function that can be registered through kolibriRegisterPublishCompleteCb() More...
 
typedef void(* KolibriTrafficCb) (KolibriBool tx, KolibriUint32 len)
 Type of call-back function that can be registered through kolibriRegisterTrafficCb() More...
 

Enumerations

enum  KolibriErr {
  KOLIBRI_ERR_NO = 0,
  KOLIBRI_ERR_GENERAL = 1,
  KOLIBRI_ERR_OPCODE = 2,
  KOLIBRI_ERR_OPTION = 3,
  KOLIBRI_ERR_PROTO_VER = 4,
  KOLIBRI_ERR_ACCESS = 5,
  KOLIBRI_ERR_PATH = 6,
  KOLIBRI_ERR_NODE_TYPE = 7,
  KOLIBRI_ERR_NODE_IDX = 8,
  KOLIBRI_ERR_NODE_PROP = 9,
  KOLIBRI_ERR_NODE_STATE = 10,
  KOLIBRI_ERR_SEQ = 11,
  KOLIBRI_ERR_DATA_TYPE = 12,
  KOLIBRI_ERR_RECIPIENT = 13,
  KOLIBRI_ERR_PROTO = 14,
  KOLIBRI_ERR_ARG_MISSING = 15,
  KOLIBRI_ERR_ARG = 16,
  KOLIBRI_ERR_VAL = 17,
  KOLIBRI_ERR_ITEM_NOT_FOUND = 18,
  KOLIBRI_ERR_ITEM_EXISTS = 19,
  KOLIBRI_ERR_INVALID,
  KOLIBRI_ERR_MEM = -2,
  KOLIBRI_ERR_BUF = -3,
  KOLIBRI_ERR_RESOURCE = -4,
  KOLIBRI_ERR_STATE = -5,
  KOLIBRI_ERR_QUEUE = -6,
  KOLIBRI_ERR_DATASET = -7,
  KOLIBRI_ERR_DNS = -8,
  KOLIBRI_ERR_SOCKET = -9,
  KOLIBRI_ERR_CONNECT = -10,
  KOLIBRI_ERR_TLS = -11,
  KOLIBRI_ERR_SEND = -12,
  KOLIBRI_ERR_RECV = -13,
  KOLIBRI_ERR_TIMEOUT = -14,
  KOLIBRI_ERR_PROXY = -15,
  KOLIBRI_ERR_LOGIN = -16,
  KOLIBRI_ERR_RPC = -17
}
 Error code. More...
 
enum  KolibriQual {
  KOLIBRI_QUAL_UNKNOWN = 0,
  KOLIBRI_QUAL_VALID,
  KOLIBRI_QUAL_SIMULATED,
  KOLIBRI_QUAL_FORCED,
  KOLIBRI_QUAL_INVALID,
  KOLIBRI_QUAL_USER_START = 100,
  KOLIBRI_QUAL_USER_END = 255
}
 Quality. More...
 
enum  KolibriDataType {
  KOLIBRI_DATA_TYPE_BOOL = 0,
  KOLIBRI_DATA_TYPE_UINT8,
  KOLIBRI_DATA_TYPE_SINT8,
  KOLIBRI_DATA_TYPE_UINT16,
  KOLIBRI_DATA_TYPE_SINT16,
  KOLIBRI_DATA_TYPE_UINT32,
  KOLIBRI_DATA_TYPE_SINT32,
  KOLIBRI_DATA_TYPE_UINT64,
  KOLIBRI_DATA_TYPE_SINT64,
  KOLIBRI_DATA_TYPE_FLOAT32,
  KOLIBRI_DATA_TYPE_FLOAT64,
  KOLIBRI_DATA_TYPE_RESERVED,
  KOLIBRI_DATA_TYPE_STR,
  KOLIBRI_DATA_TYPE_BYTE_ARRAY,
  KOLIBRI_DATA_TYPE_INVALID
}
 Data type. More...
 
enum  KolibriTriggerMode {
  KOLIBRI_TRIGGER_MODE_ANY = 0,
  KOLIBRI_TRIGGER_MODE_NONE,
  KOLIBRI_TRIGGER_MODE_CHANGE,
  KOLIBRI_TRIGGER_MODE_SAMPLE,
  KOLIBRI_TRIGGER_MODE_CHANGE_SAMPLE,
  KOLIBRI_TRIGGER_MODE_DOMAIN,
  KOLIBRI_TRIGGER_MODE_ANY_SAMPLE,
  KOLIBRI_TRIGGER_MODE_INVALID
}
 Trigger mode. More...
 
enum  KolibriQos {
  KOLIBRI_QOS_NONE = 0,
  KOLIBRI_QOS_ACK,
  KOLIBRI_QOS_ACK_QUEUE,
  KOLIBRI_QOS_COMMIT,
  KOLIBRI_QOS_COMMIT_QUEUE,
  KOLIBRI_QOS_INVALID
}
 Quality of service (QoS) level. More...
 
enum  KolibriNodeType {
  KOLIBRI_NODE_TYPE_POINT = 0,
  KOLIBRI_NODE_TYPE_GROUP,
  KOLIBRI_NODE_TYPE_INVALID
}
 Node type. More...
 
enum  KolibriPointFlag {
  KOLIBRI_POINT_FLAG_ACTIVE = 0x0001,
  KOLIBRI_POINT_FLAG_WRITEABLE = 0x0002,
  KOLIBRI_POINT_FLAG_DOMAIN_TRIGGER = 0x0004,
  KOLIBRI_POINT_FLAG_HIGH_PRIO = 0x0008,
  KOLIBRI_POINT_FLAG_RETENTIVE = 0x0010
}
 Point flags. More...
 
enum  KolibriState {
  KOLIBRI_STATE_DISCONNECTED = 0,
  KOLIBRI_STATE_CONNECTED,
  KOLIBRI_STATE_CLOCK_SYNCED,
  KOLIBRI_STATE_LOGGED_IN,
  KOLIBRI_STATE_READY
}
 Library state. More...
 
enum  KolibriCreateModifyNodeOpts {
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_MODIFY = 0x0001,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_IDX = 0x0002,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_DESCRIPTION = 0x0004,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_FLAGS = 0x0008,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_DATA_TYPE = 0x0010,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_TRIGGER_MODE = 0x0020,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_TRIGGER_DOMAIN = 0x0040,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_QOS = 0x0080,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_UPDATE_URL = 0x0100,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_HISTORY = 0x0200,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_FORMAT = 0x0400,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_SCALING = 0x0800,
  KOLIBRI_CREATE_MODIFY_NODE_OPTS_WRITE_RANGE = 0x1000
}
 Options for kolibriCreateModifyNode() function. More...
 
enum  KolibriLogType {
  KOLIBRI_LOG_TYPE_UNKNOWN = 0,
  KOLIBRI_LOG_TYPE_INFO,
  KOLIBRI_LOG_TYPE_WARN,
  KOLIBRI_LOG_TYPE_ERR,
  KOLIBRI_LOG_TYPE_FATAL,
  KOLIBRI_LOG_TYPE_DEBUG,
  KOLIBRI_LOG_TYPE_INVALID
}
 Types of log messages. More...
 
enum  KolibriLogOpt {
  KOLIBRI_LOG_OPT_CONN_LOGIN = 0x0001,
  KOLIBRI_LOG_OPT_CLOCK = 0x0002 ,
  KOLIBRI_LOG_OPT_TX_VALS = 0x0008,
  KOLIBRI_LOG_OPT_RX_VALS = 0x0010,
  KOLIBRI_LOG_OPT_PUBLISH = 0x0020,
  KOLIBRI_LOG_OPT_NODE_MANIP = 0x0040,
  KOLIBRI_LOG_OPT_RPC = 0x0080,
  KOLIBRI_LOG_OPT_EMCY = 0x0100,
  KOLIBRI_LOG_OPT_PROTO = 0x0200,
  KOLIBRI_LOG_OPT_ERR = 0x0400,
  KOLIBRI_LOG_OPT_WARN = 0x0800
}
 Log options. More...
 
enum  KolibriDatasetFlag { KOLIBRI_DATASET_FLAG_RECVED = 0x0001 }
 Flags for datasets. More...
 

Detailed Description

Documentation of data types defined by the Kolibri library.






Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated by Doxygen 1.8.10