NSDL C library

Dependents:   NSDL_HelloWorld_WiFi UbloxModemNanoServiceClient IOT-NSDL_HelloWorld LWM2M_NanoService_Ethernet ... more

Fork of nsdl_lib by Tero Heinonen

Note that use of this software requires acceptance of the Sensinode EULA: http://mbed.org/teams/Sensinode/code/nsdl_lib/wiki/EULA

sn_nsdl.h

Committer:
sam_grove
Date:
2015-04-22
Revision:
11:8a47d4c71067
Parent:
9:9db1daa49115

File content as of revision 11:8a47d4c71067:

/**
 * \file sn_nsdl.h
 *
 * \brief NanoService Devices Library generic header file
 *
 *  Created on: Aug 23, 2011
 *      Author: tero
 *
 */

#ifdef __cplusplus
extern "C" {
#endif

#ifndef SN_NSDL_H_
#define SN_NSDL_H_

#include <stdint.h>

/* * * * * * * * * * * */
/* * * * DEFINES * * * */
/* * * * * * * * * * * */

#define SN_GRS_VERSION	                0x0101

#ifndef SN_NSDL_HAVE_HTTP_CAPABILITY
#define SN_NSDL_HAVE_HTTP_CAPABILITY		0
#endif

#ifndef SN_NSDL_HAVE_HTTPS_CAPABILITY
#define SN_NSDL_HAVE_HTTPS_CAPABILITY		0
#endif

#ifndef SN_NSDL_HAVE_COAP_CAPABILITY
#define SN_NSDL_HAVE_COAP_CAPABILITY		1
#endif

/* * * Common * * */

#define SN_NSDL_SUCCESS  0
#define SN_NSDL_FAILURE (-1)

/* * * * * * * * * * * * * * */
/* * * * ENUMERATIONS  * * * */
/* * * * * * * * * * * * * * */


/**
 * \brief Used protocol
 */
typedef enum sn_nsdl_capab_
{
    SN_NSDL_PROTOCOL_HTTP           = 0x01,			/**< Unsupported */
    SN_NSDL_PROTOCOL_HTTPS          = 0x02,			/**< Unsupported */
    SN_NSDL_PROTOCOL_COAP           = 0x04			/**< Supported */
} sn_nsdl_capab_e;

/**
 * \brief Address type of given address
 */
typedef enum sn_nsdl_addr_type_
{
    SN_NSDL_ADDRESS_TYPE_IPV6       = 0x01,			/**< Supported */
    SN_NSDL_ADDRESS_TYPE_IPV4       = 0x02,			/**< Supported */
    SN_NSDL_ADDRESS_TYPE_HOSTNAME   = 0x03,			/**< Unsupported */
    SN_NSDL_ADDRESS_TYPE_NONE       = 0xFF
} sn_nsdl_addr_type_e;


#define SN_NDSL_RESOURCE_NOT_REGISTERED	0
#define SN_NDSL_RESOURCE_REGISTERING	1
#define SN_NDSL_RESOURCE_REGISTERED		2


/* * * * * * * * * * * * * */
/* * * * STRUCTURES  * * * */
/* * * * * * * * * * * * * */

/**
 * \brief Address structure of Packet data
 */
typedef struct sn_nsdl_addr_
{
    sn_nsdl_addr_type_e     type;

    uint8_t                 addr_len;
    uint8_t                *addr_ptr;

    uint16_t                port;

    void					*socket_information;

} sn_nsdl_addr_s;

/**
 * \brief Used for creating manually nsdl registration message with sn_coap_register()
 */
typedef struct registration_info_
{
	uint8_t *endpoint_ptr;			/**< Endpoint name */
	uint8_t endpoint_len;

	uint8_t *endpoint_type_ptr;		/**< Endpoint type */
	uint8_t endpoint_type_len;

	uint8_t *links_ptr;				/**< Resource registration string */
	uint16_t links_len;

} registration_info_t;

#endif /* SN_NSDL_H_ */

#ifdef __cplusplus
}
#endif