golioth.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Golioth, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef GOLIOTH_INCLUDE_NET_GOLIOTH_H_
#define GOLIOTH_INCLUDE_NET_GOLIOTH_H_
 
#include <kernel.h>
#include <net/coap.h>
#include <net/tls_credentials.h>
#include <stdint.h>
 
#define GOLIOTH_COAP_MAX_NON_PAYLOAD_LEN    128
 
#define GOLIOTH_MAX_IDENTITY_LEN    32
#define GOLIOTH_EMPTY_PACKET_LEN    (16 + GOLIOTH_MAX_IDENTITY_LEN)
 
#define GOLIOTH_LIGHTDB_PATH(x)     ".d/" x
#define GOLIOTH_LIGHTDB_STREAM_PATH(x)  ".s/" x
 
struct golioth_unsecure {
    const uint8_t *identity;
    size_t identity_len;
};
 
struct golioth_tls {
    sec_tag_t *sec_tag_list;
    size_t sec_tag_count;
};
 
struct golioth_client {
    int proto;
 
    union {
        struct golioth_unsecure unsecure;
        struct golioth_tls tls;
    };
 
    uint8_t *rx_buffer;
    size_t rx_buffer_len;
    size_t rx_received;
 
    struct coap_packet rx_packet;
    struct coap_option rx_options[CONFIG_GOLIOTH_COAP_MAX_OPTIONS];
 
    struct k_mutex lock;
    int sock;
 
    void (*on_connect)(struct golioth_client *client);
    void (*on_message)(struct golioth_client *client,
               struct coap_packet *rx);
};
 
struct golioth_blockwise_observe_ctx;
 
typedef int (*golioth_blockwise_observe_received_t)(struct golioth_blockwise_observe_ctx *ctx,
                            const uint8_t *data,
                            size_t offset, size_t len,
                            bool last);
 
struct golioth_blockwise_observe_ctx {
    struct coap_block_context block_ctx;
    struct golioth_client *client;
    const char *path;
    golioth_blockwise_observe_received_t received_cb;
};
 
struct golioth_blockwise_download_ctx;
 
typedef int (*golioth_blockwise_download_received_t)(struct golioth_blockwise_download_ctx *ctx,
                             const uint8_t *data,
                             size_t offset, size_t len,
                             bool last);
 
struct golioth_blockwise_download_ctx {
    struct coap_block_context block_ctx;
    struct golioth_client *client;
    struct coap_reply *reply;
    uint8_t token[COAP_TOKEN_MAX_LEN];
    golioth_blockwise_download_received_t received_cb;
};
 
void golioth_blockwise_download_init(struct golioth_client *client,
                     struct golioth_blockwise_download_ctx *ctx);
 
static inline void golioth_lock(struct golioth_client *client)
{
    k_mutex_lock(&client->lock, K_FOREVER);
}
 
static inline void golioth_unlock(struct golioth_client *client)
{
    k_mutex_unlock(&client->lock);
}
 
void golioth_init(struct golioth_client *client);
 
int golioth_connect(struct golioth_client *client, const char *host,
            uint16_t port);
 
int golioth_disconnect(struct golioth_client *client);
 
int golioth_set_proto_coap_udp(struct golioth_client *client,
                   uint8_t *identity, size_t identity_len);
 
int golioth_set_proto_coap_dtls(struct golioth_client *client,
                sec_tag_t *sec_tag_list,
                size_t sec_tag_count);
 
int golioth_send_coap(struct golioth_client *client,
              struct coap_packet *packet);
 
int golioth_send_coap_payload(struct golioth_client *client,
                  struct coap_packet *packet,
                  uint8_t *data, uint16_t data_len);
 
int golioth_ping(struct golioth_client *client);
 
int golioth_send_hello(struct golioth_client *client);
 
int golioth_lightdb_get(struct golioth_client *client, const uint8_t *path,
            enum coap_content_format format,
            struct coap_reply *reply, coap_reply_t reply_cb);
 
int golioth_lightdb_set(struct golioth_client *client, const uint8_t *path,
            enum coap_content_format format,
            uint8_t *data, uint16_t data_len);
 
int golioth_lightdb_delete(struct golioth_client *client, const uint8_t *path);
 
int golioth_lightdb_observe(struct golioth_client *client, const uint8_t *path,
                enum coap_content_format format,
                struct coap_reply *reply, coap_reply_t reply_cb);
 
int golioth_observe_blockwise(struct golioth_client *client,
                  struct golioth_blockwise_observe_ctx *ctx,
                  const char *path, struct coap_reply *reply,
                  golioth_blockwise_observe_received_t received_cb);
 
int golioth_process_rx(struct golioth_client *client);
 
#endif /* GOLIOTH_INCLUDE_NET_GOLIOTH_H_ */