MeterLogger
Data Structures | Typedefs | Enumerations | Functions
airkiss.h File Reference

Go to the source code of this file.

Data Structures

struct  airkiss_config_t
 

Typedefs

typedef void *(* airkiss_memset_fn) (void *ptr, int value, unsigned int num)
 
typedef void *(* airkiss_memcpy_fn) (void *dst, const void *src, unsigned int num)
 
typedef int(* airkiss_memcmp_fn) (const void *ptr1, const void *ptr2, unsigned int num)
 
typedef int(* airkiss_printf_fn) (const char *format,...)
 

Enumerations

enum  airkiss_lan_ret_t {
  AIRKISS_LAN_ERR_OVERFLOW = -5, AIRKISS_LAN_ERR_CMD = -4, AIRKISS_LAN_ERR_PAKE = -3, AIRKISS_LAN_ERR_PARA = -2,
  AIRKISS_LAN_ERR_PKG = -1, AIRKISS_LAN_CONTINUE = 0, AIRKISS_LAN_SSDP_REQ = 1, AIRKISS_LAN_PAKE_READY = 2
}
 
enum  airkiss_lan_cmdid_t { AIRKISS_LAN_SSDP_REQ_CMD = 0x1, AIRKISS_LAN_SSDP_RESP_CMD = 0x1001, AIRKISS_LAN_SSDP_NOTIFY_CMD = 0x1002 }
 

Functions

const char * airkiss_version (void)
 Get airkiss lib version. More...
 
int airkiss_lan_recv (const void *body, unsigned short length, const airkiss_config_t *config)
 Receive UDP packet and input this API for analyzing. More...
 
int airkiss_lan_pack (airkiss_lan_cmdid_t ak_lan_cmdid, void *appid, void *deviceid, void *_datain, unsigned short inlength, void *_dataout, unsigned short *outlength, const airkiss_config_t *config)
 Packaging the UDP packet to send. More...
 

Typedef Documentation

◆ airkiss_memcmp_fn

typedef int(* airkiss_memcmp_fn) (const void *ptr1, const void *ptr2, unsigned int num)

Definition at line 18 of file airkiss.h.

◆ airkiss_memcpy_fn

typedef void*(* airkiss_memcpy_fn) (void *dst, const void *src, unsigned int num)

Definition at line 17 of file airkiss.h.

◆ airkiss_memset_fn

typedef void*(* airkiss_memset_fn) (void *ptr, int value, unsigned int num)

Definition at line 16 of file airkiss.h.

◆ airkiss_printf_fn

typedef int(* airkiss_printf_fn) (const char *format,...)

Definition at line 19 of file airkiss.h.

Enumeration Type Documentation

◆ airkiss_lan_cmdid_t

Enumerator
AIRKISS_LAN_SSDP_REQ_CMD 
AIRKISS_LAN_SSDP_RESP_CMD 
AIRKISS_LAN_SSDP_NOTIFY_CMD 

Definition at line 75 of file airkiss.h.

◆ airkiss_lan_ret_t

Enumerator
AIRKISS_LAN_ERR_OVERFLOW 
AIRKISS_LAN_ERR_CMD 
AIRKISS_LAN_ERR_PAKE 
AIRKISS_LAN_ERR_PARA 
AIRKISS_LAN_ERR_PKG 
AIRKISS_LAN_CONTINUE 
AIRKISS_LAN_SSDP_REQ 
AIRKISS_LAN_PAKE_READY 

Definition at line 45 of file airkiss.h.

46 {
47  /* the length of the data buffer is lack*/
49 
50  /* Do not support the type of instruction */
52 
53  /* Error reading data package */
55 
56  /* Error function passing parameters */
58 
59  /* Packet data error */
61 
62  /* Message format is correct */
64 
65  /* Find equipment request packet is received */
67 
68  /* Packet packaging complete */
70 
71 
airkiss_lan_ret_t
Definition: airkiss.h:45

Function Documentation

◆ airkiss_lan_pack()

int airkiss_lan_pack ( airkiss_lan_cmdid_t  ak_lan_cmdid,
void *  appid,
void *  deviceid,
void *  _datain,
unsigned short  inlength,
void *  _dataout,
unsigned short *  outlength,
const airkiss_config_t config 
)

Packaging the UDP packet to send.

Attention
null.
Parameters
airkiss_lan_cmdid_tak_lan_cmdid : The packet type.
void*appid : Vendor's Wechat public number id.
void*deviceid : device model id.
void*_datain : the data to be sent.
unsignedshort inlength : the lenth of data to be sent.
void*_dataout : Data buffer addr.
unsignedshort* outlength : the size of data buffer.
constairkiss_config_t* config : input struct airkiss_config_t
Returns
>=0 : succeed (reference airkiss_lan_ret_t)
<0 : error code (reference airkiss_lan_ret_t)

◆ airkiss_lan_recv()

int airkiss_lan_recv ( const void *  body,
unsigned short  length,
const airkiss_config_t config 
)

Receive UDP packet and input this API for analyzing.

Attention
null.
Parameters
constvoid* body : The start of the UDP message body data pointer.
unsignedshort length : the effective length of data.
constairkiss_config_t* config : input struct airkiss_config_t
Returns
>=0 : succeed (reference airkiss_lan_ret_t)
<0 : error code (reference airkiss_lan_ret_t)

◆ airkiss_version()

const char* airkiss_version ( void  )

Get airkiss lib version.

Attention
The lenth of version is unknown
Parameters
null.
Returns
const char*