dmc_connect_api.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// Copyright 2019-2020 ARM Ltd.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------

#ifndef __DMC_CONNECT_API_H__
#define __DMC_CONNECT_API_H__

#include "lwm2m_interface.h"
#include "lwm2m_registry.h"

#ifdef MBED_CLOUD_CLIENT_SUPPORT_UPDATE
#include "dmc_update_api.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    M2M_CLIENT_EVENT_SETUP_COMPLETED = 100,     
    M2M_CLIENT_EVENT_NETWORK_SETUP_COMPLETED    
} m2m_client_event_t;

typedef struct pdmc_endpoint_info_ {
    char endpoint_name[MAX_ALLOWED_STRING_LENGTH];
    char device_id[MAX_ALLOWED_STRING_LENGTH];
} pdmc_endpoint_info_s;

/***
 * The normal sequence of use:
 * -# pdmc_connect_init
 * -# lwm2m_interface_t* if = pdmc_connect_get_interface
 * -# registry_t* reg = &if.endpoint.registry
 * -# pdmc_connect_add_cloud_resource(reg, ...)
 * -# pdmc_connect_register
 * See also `lwm2m_registry.h` for relevant value modification functions.
**/

void pdmc_connect_init(uint8_t event_handler_id);

void pdmc_connect_deinit(void);

void pdmc_connect_register(void* iface);

void pdmc_connect_register_update(void);

void pdmc_connect_close(void);

lwm2m_interface_t *pdmc_connect_get_interface(void);

#ifndef MBED_CLOUD_CLIENT_DISABLE_REGISTRY

int pdmc_connect_add_cloud_resource(registry_t *registry, registry_path_t *path,
                                        const uint16_t object, const uint16_t object_instance, const uint16_t resource,
                                        bool auto_observable, registry_callback_t callback);

int pdmc_connect_add_cloud_resource_instance(registry_t *registry, registry_path_t *path,
                                    const uint16_t object, const uint16_t object_instance, const uint16_t resource,
                                    const uint16_t resource_instance,
                                    bool auto_observable, registry_callback_t callback);
#endif // !MBED_CLOUD_CLIENT_DISABLE_REGISTRY

bool pdmc_connect_endpoint_info(pdmc_endpoint_info_s *endpoint_info);

bool pdmc_connect_get_endpoint_name(char *endpoint_name, size_t size);

bool pdmc_connect_get_device_id(char *device_id, size_t size);

void pdmc_connect_pause(void);

void pdmc_connect_resume(void *iface);

#ifdef __cplusplus
}
#endif

#endif // __DMC_CONNECT_API_H__