Definitions.h

Go to the documentation of this file.

#ifndef TYPES_H_INCLUDED
#define TYPES_H_INCLUDED
 
// Explicitly include Arduino header for IPAddress definition.
#include <Arduino.h>
 
// Include Arduino UDP library.
#include "Udp.h"
 
// SECTION Constants.
#ifndef COAP_MAX_MESSAGE_SIZE
#define COAP_MAX_MESSAGE_SIZE 128U
#endif
#ifndef COAP_MAX_CALLBACKS
#define COAP_MAX_CALLBACKS 10U
#endif
#ifndef COAP_MAX_OBSERVERS
#define COAP_MAX_OBSERVERS 4U
#endif
#ifndef COAP_OBSERVER_LEASE_MS
#define COAP_OBSERVER_LEASE_MS 60000UL
#endif
#ifndef COAP_ACK_MIN_TIMEOUT_MS
#define COAP_ACK_MIN_TIMEOUT_MS 2000UL
#endif
#ifndef COAP_ACK_RANDOM_FACTOR
#define COAP_ACK_RANDOM_FACTOR 1.5f
#endif
#define COAP_ACK_MAX_TIMEOUT_MS (unsigned long)(COAP_ACK_MIN_TIMEOUT_MS * COAP_ACK_RANDOM_FACTOR)
#ifndef COAP_MAX_RETRANSMIT
#define COAP_MAX_RETRANSMIT 4U
#endif
#ifndef COAP_CONFIRMABLE_MESSAGE_QUEUE_SIZE
#define COAP_CONFIRMABLE_MESSAGE_QUEUE_SIZE 2U
#endif
 // End of "Configurable constants" group
 
constexpr uint8_t COAP_VERSION = 0x01;
constexpr uint8_t COAP_HEADER_SIZE = 4;
constexpr uint8_t COAP_PAYLOAD_MARKER = 0xFF;
constexpr uint16_t COAP_DEFAULT_PORT = 5683;
constexpr uint8_t COAP_CODE_ENCODE(uint8_t class_, uint8_t detail) { return (class_ << 5) | (detail); }
constexpr uint8_t COAP_MAX_TOKEN_LENGTH = 8;
 // End of "Non configurable constants" group
 
// !SECTION End of all constants.
 
namespace Coap
{
    // SECTION Enums.
    enum class MessageType : uint8_t
    {
        CON = 0,
        NON = 1,
        ACK = 2,
        RST = 3
    };
 
    enum class MessageCode : uint8_t
    {
        EMPTY = COAP_CODE_ENCODE(0, 0),
 
        // SECTION 0.xx Request MessageCodes
        GET = COAP_CODE_ENCODE(0, 1),
        POST = COAP_CODE_ENCODE(0, 2),
        PUT = COAP_CODE_ENCODE(0, 3),
        DELETE = COAP_CODE_ENCODE(0, 4),
        // !SECTION End of 0.xx Request MessageCodes
 
        // SECTION 2.xx Success response codes
        CREATED = COAP_CODE_ENCODE(2, 1),
        DELETED = COAP_CODE_ENCODE(2, 2),
        VALID = COAP_CODE_ENCODE(2, 3),
        CHANGED = COAP_CODE_ENCODE(2, 4),
        CONTENT = COAP_CODE_ENCODE(2, 5),
        // !SECTION End of 2.xx Success response codes
 
        // SECTION 4.xx Client Error response codes
        BAD_REQUEST = COAP_CODE_ENCODE(4, 0),
        UNAUTHORIZED = COAP_CODE_ENCODE(4, 1),
        BAD_OPTION = COAP_CODE_ENCODE(4, 2),
        FORBIDDEN = COAP_CODE_ENCODE(4, 3),
        NOT_FOUND = COAP_CODE_ENCODE(4, 4),
        METHOD_NOT_ALLOWED = COAP_CODE_ENCODE(4, 5),
        NOT_ACCEPTABLE = COAP_CODE_ENCODE(4, 6),
        PRECONDITION_FAILED = COAP_CODE_ENCODE(4, 12),
        REQUEST_ENTITY_TOO_LARGE = COAP_CODE_ENCODE(4, 13),
        UNSUPPORTED_CONTENT_FORMAT = COAP_CODE_ENCODE(4, 15),
        // !SECTION End of 4.xx Client Error response codes
 
        // SECTION 5.xx Server Error response codes
        INTERNAL_SERVER_ERROR = COAP_CODE_ENCODE(5, 0),
        NOT_IMPLEMENTED = COAP_CODE_ENCODE(5, 1),
        BAD_GATEWAY = COAP_CODE_ENCODE(5, 2),
        SERVICE_UNAVAILABLE = COAP_CODE_ENCODE(5, 3),
        GATEWAY_TIMEOUT = COAP_CODE_ENCODE(5, 4),
        PROXYING_NOT_SUPPORTED = COAP_CODE_ENCODE(5, 5),
        // !SECTION End of 5.xx Server Error response codes
    };
 
    enum class OptionNumber : uint16_t
    {
        IF_MATCH = 1,
        URI_HOST = 3,
        E_TAG = 4,
        IF_NONE_MATCH = 5,
        OBSERVE = 6,
        URI_PORT = 7,
        LOCATION_PATH = 8,
        URI_PATH = 11,
        CONTENT_FORMAT = 12,
        MAX_AGE = 14,
        URI_QUERY = 15,
        ACCEPT = 17,
        LOCATION_QUERY = 20,
        PROXY_URI = 35,
        PROXY_SCHEME = 39,
        SIZE1 = 60
    };
 
    enum class ContentFormat : uint16_t
    {
        TEXT_PLAIN = 0,
        APPLICATION_LINK_FORMAT = 40,
        APPLICATION_XML = 41,
        APPLICATION_OCTET_STREAM = 42,
        APPLICATION_EXI = 47,
        APPLICATION_JSON = 50,
        APPLICATION_CBOR = 60
    };
 
    enum class ObserveValue : uint8_t
    {
        REGISTER = 0,
        DEREGISTER = 1
    };
 
    enum class ErrorCode : int8_t
    {
        OK = 0,
        NOT_FOUND = -1,
        MESSAGE_TOO_LARGE = -2,
        MALFORMED_MESSAGE = -3,
        INVALID_ARGUMENT = -4,
        NOT_SUPPORTED = -5,
        NETWORK = -6,
        UNEXPECTED = -99
    };
 
    // !SECTION End of Enums.
 
    class Message; // Forward declaration.
 
    typedef void (*Callback)(Message &message, IPAddress ip, uint16_t port);
}
 
#endif // TYPES_H_INCLUDED