PXREARobotSDK
Robot SDK for client-side communication
Loading...
Searching...
No Matches
PXREARobotSDK.h
Go to the documentation of this file.
1
5#ifndef PXREACLIENTSDK_H
6#define PXREACLIENTSDK_H
7#ifdef _WIN32
8#if defined(PXREACLIENTSDK_LIBRARY)
9# define PXREACLIENTSDK_EXPORT __declspec(dllexport)
10#else
11# define PXREACLIENTSDK_EXPORT __declspec(dllimport)
12#endif
13#endif
14
15#ifdef __linux__
16#if defined(PXREACLIENTSDK_LIBRARY)
17# define PXREACLIENTSDK_EXPORT __attribute__((visibility("default")))
18#else
19# define PXREACLIENTSDK_EXPORT __attribute__((visibility("default")))
20#endif
21#endif
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
46
47
48
49
50
51
52
53
55typedef struct {
57 char devID[32];
59 char stateJson[16352];
61
62
63typedef struct {
65 char devID[32];
67 uint64_t dataSize;
69 const char* dataPtr;
71
72
73
74
82typedef void(*pfPXREAClientCallback)(void* context,PXREAClientCallbackType type,int status,void* userData);
83
91PXREACLIENTSDK_EXPORT int PXREAInit(void* context,pfPXREAClientCallback cliCallback,unsigned mask);
96PXREACLIENTSDK_EXPORT int PXREADeinit();
97
105PXREACLIENTSDK_EXPORT int PXREADeviceControlJson(const char *devID,const char *parameterJson);
115PXREACLIENTSDK_EXPORT int PXREASendBytesToDevice(const char* devID,const char* data,unsigned len);
116#ifdef __cplusplus
117}
118#endif
119
120#endif // PXREACLIENTSDK_H
PXREACLIENTSDK_EXPORT int PXREADeviceControlJson(const char *devID, const char *parameterJson)
Send JSON format command to device.
PXREACLIENTSDK_EXPORT int PXREASendBytesToDevice(const char *devID, const char *data, unsigned len)
Send byte stream to specified device.
PXREACLIENTSDK_EXPORT int PXREADeinit()
Termination interface.
PXREACLIENTSDK_EXPORT int PXREAInit(void *context, pfPXREAClientCallback cliCallback, unsigned mask)
SDK initialization interface.
void(* pfPXREAClientCallback)(void *context, PXREAClientCallbackType type, int status, void *userData)
Client callback for receiving server messages.
Definition PXREARobotSDK.h:82
PXREAClientCallbackType
Definition PXREARobotSDK.h:28
@ PXREAServerDisconnect
Server disconnected.
Definition PXREARobotSDK.h:32
@ PXREADeviceStateJson
Device state in JSON format.
Definition PXREARobotSDK.h:40
@ PXREADeviceCustomMessage
Custom message.
Definition PXREARobotSDK.h:42
@ PXREADeviceFind
Device online.
Definition PXREARobotSDK.h:34
@ PXREAServerConnect
Server connected.
Definition PXREARobotSDK.h:30
@ PXREAFullMask
Mask for enabling all callbacks.
Definition PXREARobotSDK.h:44
@ PXREADeviceConnect
Device connected.
Definition PXREARobotSDK.h:38
@ PXREADeviceMissing
Device offline.
Definition PXREARobotSDK.h:36
Definition PXREARobotSDK.h:63
uint64_t dataSize
Data size.
Definition PXREARobotSDK.h:67
char devID[32]
Device serial number.
Definition PXREARobotSDK.h:65
const char * dataPtr
Data pointer, valid within callback.
Definition PXREARobotSDK.h:69
Device state in JSON format.
Definition PXREARobotSDK.h:55
char devID[32]
Device serial number.
Definition PXREARobotSDK.h:57
char stateJson[16352]
JSON string containing device state information.
Definition PXREARobotSDK.h:59