dult.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _DULT_DULT_H_
#define _DULT_DULT_H_
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
#include <zephyr/sys/slist.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DULT_PRODUCT_DATA_LEN   8
 
enum dult_network_id {
        DULT_NETWORK_ID_APPLE = 0x01,
        DULT_NETWORK_ID_GOOGLE = 0x02,
};
 
enum dult_accessory_capability {
        DULT_ACCESSORY_CAPABILITY_PLAY_SOUND_BIT_POS = 0,
 
        DULT_ACCESSORY_CAPABILITY_MOTION_DETECTOR_UT_BIT_POS = 1,
 
        DULT_ACCESSORY_CAPABILITY_ID_LOOKUP_NFC_BIT_POS = 2,
 
        DULT_ACCESSORY_CAPABILITY_ID_LOOKUP_BLE_BIT_POS = 3,
};
 
struct dult_version {
        uint16_t major;
 
        uint8_t minor;
 
        uint8_t revision;
};
 
struct dult_user {
        const uint8_t *product_data;
 
        const char *manufacturer_name;
 
        const char *model_name;
 
        uint8_t accessory_category;
 
        uint32_t accessory_capabilities;
 
        enum dult_network_id network_id;
 
        struct dult_version firmware_version;
 
        const struct dult_version *network_version;
};
 
int dult_user_register(const struct dult_user *user);
 
int dult_user_unregister(const struct dult_user *user);
 
int dult_battery_level_set(const struct dult_user *user, uint8_t percentage_level);
 
struct dult_id_read_state_cb {
        int (*payload_get)(uint8_t *buf, size_t *len);
 
        void (*exited)(void);
};
 
int dult_id_read_state_cb_register(const struct dult_user *user,
                                   const struct dult_id_read_state_cb *cb);
 
int dult_id_read_state_enter(const struct dult_user *user);
 
#define DULT_SOUND_DURATION_BT_GATT_MIN_MS (5000U)
 
enum dult_sound_src {
        DULT_SOUND_SRC_BT_GATT,
 
        DULT_SOUND_SRC_MOTION_DETECTOR,
 
        DULT_SOUND_SRC_EXTERNAL,
};
 
struct dult_sound_cb {
        void (*sound_start)(enum dult_sound_src src);
 
        void (*sound_stop)(enum dult_sound_src src);
};
 
int dult_sound_cb_register(const struct dult_user *user, const struct dult_sound_cb *cb);
 
struct dult_sound_state_param {
        bool active;
 
        enum dult_sound_src src;
};
 
int dult_sound_state_update(const struct dult_user *user,
                            const struct dult_sound_state_param *param);
 
struct dult_motion_detector_cb {
        void (*start)(void);
 
        bool (*period_expired)(void);
 
        void (*stop)(void);
};
 
int dult_motion_detector_cb_register(const struct dult_user *user,
                                     const struct dult_motion_detector_cb *cb);
 
enum dult_near_owner_state_mode {
        DULT_NEAR_OWNER_STATE_MODE_SEPARATED,
 
        DULT_NEAR_OWNER_STATE_MODE_NEAR_OWNER,
 
        DULT_NEAR_OWNER_STATE_MODE_COUNT,
};
 
int dult_near_owner_state_set(const struct dult_user *user, enum dult_near_owner_state_mode mode);
 
int dult_enable(const struct dult_user *user);
 
int dult_reset(const struct dult_user *user);
 
bool dult_user_is_associated(const struct dult_user *user);
 
bool dult_is_any_associated(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _DULT_DULT_H_ */