airkiss.h

Go to the documentation of this file.

/*
 * airkiss.h
 *
 *  Created on: 2015-1-26
 *      Author: peterfan
 */

#ifndef AIRKISS_H_
#define AIRKISS_H_

#ifdef __cplusplus
extern "C" {
#endif


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, ...);



typedef struct
{
    airkiss_memset_fn memset;
    airkiss_memcpy_fn memcpy;
    airkiss_memcmp_fn memcmp;
    airkiss_printf_fn printf;

} airkiss_config_t;

/**
  * @brief     Get airkiss lib version.
  *
  * @attention The lenth of version is unknown
  *
  * @param     null.
  *
  * @return    const char*
  */

const char* airkiss_version(void);


typedef enum
{
    /* the length of the data buffer is lack*/
    AIRKISS_LAN_ERR_OVERFLOW = -5,

    /* Do not support the type of instruction */
    AIRKISS_LAN_ERR_CMD = -4,

    /* Error reading data package */
    AIRKISS_LAN_ERR_PAKE = -3,

    /* Error function passing parameters */
    AIRKISS_LAN_ERR_PARA = -2,

    /* Packet data error */
    AIRKISS_LAN_ERR_PKG = -1,

    /* Message format is correct */
    AIRKISS_LAN_CONTINUE = 0,

    /* Find equipment request packet is received */
    AIRKISS_LAN_SSDP_REQ = 1,

    /* Packet packaging complete */
    AIRKISS_LAN_PAKE_READY = 2


} airkiss_lan_ret_t;


typedef enum
{
    AIRKISS_LAN_SSDP_REQ_CMD = 0x1,
    AIRKISS_LAN_SSDP_RESP_CMD = 0x1001,
    AIRKISS_LAN_SSDP_NOTIFY_CMD = 0x1002
} airkiss_lan_cmdid_t;

/**
  * @brief     Receive UDP packet and input this API for analyzing.
  *
  * @attention null.
  *
  * @param     const void* body : The start of the UDP message body data pointer.
  * @param     unsigned short length : the effective length of data.
  * @param     const airkiss_config_t* config : input struct airkiss_config_t
  *
  * @return    >=0 : succeed (reference airkiss_lan_ret_t)
  * @return    <0  : error code (reference airkiss_lan_ret_t)
  */

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


/**
  * @brief     Packaging the UDP packet to send.
  *
  * @attention null.
  *
  * @param     airkiss_lan_cmdid_t ak_lan_cmdid : The packet type.
  * @param     void* appid : Vendor's Wechat public number id.
  * @param     void* deviceid : device model id.
  * @param     void* _datain : the data to be sent.
  * @param     unsigned short inlength : the lenth of data to be sent.
  * @param     void* _dataout : Data buffer addr.
  * @param     unsigned short* outlength : the size of data buffer.
  * @param     const airkiss_config_t* config : input struct airkiss_config_t
  *
  * @return    >=0 : succeed (reference airkiss_lan_ret_t)
  * @return    <0  : error code (reference airkiss_lan_ret_t)
  */

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);

#ifdef __cplusplus
}
#endif

#endif /* AIRKISS_H_ */