settings.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Golioth, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef GOLIOTH_INCLUDE_NET_GOLIOTH_SETTINGS_H_
#define GOLIOTH_INCLUDE_NET_GOLIOTH_SETTINGS_H_
 
#include <stdint.h>
#include <zephyr/net/coap.h>
 
struct golioth_client;
 
enum golioth_settings_status {
    /* Setting applied successfully to the device */
    GOLIOTH_SETTINGS_SUCCESS = 0,
    /* The setting key is not recognized, this setting is unknown */
    GOLIOTH_SETTINGS_KEY_NOT_RECOGNIZED = 1,
    /* The setting key is too long, ill-formatted */
    GOLIOTH_SETTINGS_KEY_NOT_VALID = 2,
    /* The setting value is improperly formatted */
    GOLIOTH_SETTINGS_VALUE_FORMAT_NOT_VALID = 3,
    /* The setting value is outside of allowed range */
    GOLIOTH_SETTINGS_VALUE_OUTSIDE_RANGE = 4,
    /* The setting value string is too long, exceeds max length */
    GOLIOTH_SETTINGS_VALUE_STRING_TOO_LONG = 5,
    /* Other general error */
    GOLIOTH_SETTINGS_GENERAL_ERROR = 6,
};
 
enum golioth_settings_value_type {
    GOLIOTH_SETTINGS_VALUE_TYPE_UNKNOWN,
    GOLIOTH_SETTINGS_VALUE_TYPE_BOOL,
    GOLIOTH_SETTINGS_VALUE_TYPE_FLOAT,
    GOLIOTH_SETTINGS_VALUE_TYPE_STRING,
    GOLIOTH_SETTINGS_VALUE_TYPE_INT64,
};
 
struct golioth_settings_value {
    enum golioth_settings_value_type type;
    union {
        bool b;
        float f;
        struct {
            const char *ptr; /* not NULL-terminated */
            size_t len;
        } string;
        int64_t i64;
    };
};
 
typedef enum golioth_settings_status (*golioth_settings_cb)(
        const char *key,
        const struct golioth_settings_value *value);
 
struct golioth_settings {
#if defined(CONFIG_GOLIOTH_SETTINGS)
    bool initialized;
    golioth_settings_cb callback;
#endif
};
 
int golioth_settings_register_callback(struct golioth_client *client,
                       golioth_settings_cb callback);
 
int golioth_settings_observe(struct golioth_client *client);
 
#endif /* GOLIOTH_INCLUDE_NET_GOLIOTH_SETTINGS_H_ */