pt_api.h

Go to the documentation of this file.

/*
 * ----------------------------------------------------------------------------
 * Copyright 2018 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 PT_API_VERSION
#define PT_API_VERSION 2
#endif
#if PT_API_VERSION != 2
#error "Including mixed versions of Protocol API"
#endif

#ifndef PT_API_H_
#define PT_API_H_

#include <stdbool.h>

#include "pt-client-2/pt_common_api.h"
#include "pt-client-2/pt_client_api.h"
#include "pt-client-2/pt_userdata_api.h"
#include "pt-client-2/pt_devices_api.h"

#ifdef MBED_EDGE_SUBDEVICE_FOTA
#include "pt-client-2/pt_firmware_download_api_internal.h"
#endif // MBED_EDGE_SUBDEVICE_FOTA

typedef pt_status_t (*pt_resource_callback)(const connection_id_t connection_id,
                                            const char *device_id,
                                            const uint16_t object_id,
                                            const uint16_t object_instance_id,
                                            const uint16_t resource_id,
                                            const uint8_t operation,
                                            const uint8_t *value,
                                            const uint32_t size,
                                            void *userdata);

typedef void (*pt_resource_value_free_callback)(void *value);

typedef void (*pt_device_response_handler)(const connection_id_t connection_id, const char *device_id, void *userdata);

pt_status_t pt_device_create_with_userdata(const connection_id_t connection_id,
                                    const char *device_id,
                                    const uint32_t lifetime,
                                    const queuemode_t queuemode,
                                    pt_userdata_t *userdata);

#ifdef MBED_EDGE_SUBDEVICE_FOTA

pt_status_t pt_device_add_manifest_callback(const connection_id_t connection_id,
                                            manifest_metadata_handler cb);

pt_status_t pt_download_asset(const connection_id_t connection_id,
                              const char *device_id,
                              uint64_t size,
                              pt_download_cb success_handler,
                              pt_download_cb failure_handler,
                              void *userdata);

#endif // MBED_EDGE_SUBDEVICE_FOTA

pt_status_t pt_device_create_with_feature_flags(const connection_id_t connection_id,
                                                const char *device_id,
                                                const uint32_t lifetime,
                                                const queuemode_t queuemode,
                                                const uint32_t features,
                                                pt_userdata_t *userdata);

pt_status_t pt_device_create(const connection_id_t connection_id,
                             const char *device_id,
                             const uint32_t lifetime,
                             const queuemode_t queuemode);

pt_status_t pt_device_get_feature_flags(const connection_id_t connection_id,
                                        const char *device_id,
                                        uint32_t *features);

pt_status_t pt_device_register(const connection_id_t connection_id,
                               const char *device_id,
                               pt_device_response_handler success_handler,
                               pt_device_response_handler failure_handler,
                               void *userdata);

pt_status_t pt_device_unregister(const connection_id_t connection_id,
                                 const char *device_id,
                                 pt_device_response_handler success_handler,
                                 pt_device_response_handler failure_handler,
                                 void *userdata);

pt_status_t pt_device_write_values(const connection_id_t connection_id,
                                   const char *device_id,
                                   pt_device_response_handler success_handler,
                                   pt_device_response_handler failure_handler,
                                   void *userdata);

pt_status_t pt_device_set_resource_value(const connection_id_t connection_id,
                                         const char *device_id,
                                         const uint16_t object_id,
                                         const uint16_t object_instance_id,
                                         const uint16_t resource_id,
                                         const uint8_t *value,
                                         uint32_t value_len,
                                         pt_resource_value_free_callback value_free_cb);

bool pt_device_exists(const connection_id_t connection_id, const char *device_id);

bool pt_device_resource_exists(const connection_id_t connection_id,
                               const char *device_id,
                               const uint16_t object_id,
                               const uint16_t object_instance_id,
                               const uint16_t resource_id);

pt_status_t pt_device_add_resource(const connection_id_t connection_id,
                                   const char *device_id,
                                   const uint16_t object_id,
                                   const uint16_t object_instance_id,
                                   const uint16_t resource_id,
                                   const char *resource_name,
                                   const Lwm2mResourceType type,
                                   uint8_t *value,
                                   uint32_t value_size,
                                   pt_resource_value_free_callback value_free_cb);

pt_status_t pt_device_add_resource_with_callback(const connection_id_t connection_id,
                                                 const char *device_id,
                                                 const uint16_t object_id,
                                                 const uint16_t object_instance_id,
                                                 const uint16_t resource_id,
                                                 const char *resource_name,
                                                 const Lwm2mResourceType type,
                                                 const uint8_t operations,
                                                 uint8_t *value,
                                                 uint32_t value_size,
                                                 pt_resource_value_free_callback value_free_cb,
                                                 pt_resource_callback callback);

pt_status_t pt_device_get_resource_value(connection_id_t connection_id,
                                         const char *device_id,
                                         const uint16_t object_id,
                                         const uint16_t object_instance_id,
                                         const uint16_t resource_id,
                                         uint8_t **value_out,
                                         uint32_t *value_len_out);

int32_t pt_device_get_next_free_object_instance_id(connection_id_t connection_id,
                                                   const char *device_id,
                                                   uint16_t object_id);

pt_userdata_t *pt_device_get_userdata(connection_id_t connection_id, const char *device_id);

pt_userdata_t *pt_resource_get_userdata(connection_id_t connection_id,
                                        const char *device_id,
                                        const uint16_t object_id,
                                        const uint16_t object_instance_id,
                                        const uint16_t resource_id);

pt_status_t pt_device_set_userdata(connection_id_t connection_id, const char *device_id, pt_userdata_t *userdata);

pt_status_t pt_resource_set_userdata(connection_id_t connection_id,
                                     const char *device_id,
                                     const uint16_t object_id,
                                     const uint16_t object_instance_id,
                                     const uint16_t resource_id,
                                     pt_userdata_t *userdata);

#endif /* PT_API_H_ */