update_ui_example.h

00001 // ----------------------------------------------------------------------------
00002 // Copyright 2016-2018 ARM Ltd.
00003 //
00004 // SPDX-License-Identifier: Apache-2.0
00005 //
00006 // Licensed under the Apache License, Version 2.0 (the "License");
00007 // you may not use this file except in compliance with the License.
00008 // You may obtain a copy of the License at
00009 //
00010 //     http://www.apache.org/licenses/LICENSE-2.0
00011 //
00012 // Unless required by applicable law or agreed to in writing, software
00013 // distributed under the License is distributed on an "AS IS" BASIS,
00014 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00015 // See the License for the specific language governing permissions and
00016 // limitations under the License.
00017 // ----------------------------------------------------------------------------
00018 
00019 #ifndef UPDATE_UI_EXAMPLE_H
00020 #define UPDATE_UI_EXAMPLE_H
00021 
00022 #include "mbed-cloud-client/MbedCloudClient.h"
00023 
00024 #ifdef MBED_CLOUD_CLIENT_SUPPORT_UPDATE
00025 
00026 #ifdef ARM_UPDATE_CLIENT_VERSION_VALUE
00027 #if ARM_UPDATE_CLIENT_VERSION_VALUE > 101000
00028 /**
00029  * @brief Function for authorizing firmware downloads and reboots.
00030  * @param request The request under consideration.
00031  */
00032 void update_authorize(int32_t request);
00033 #endif
00034 #endif
00035 
00036 /**
00037  * @brief Callback function for reporting the firmware download progress.
00038  * @param progress Received bytes.
00039  * @param total Total amount of bytes to be received.
00040  */
00041 void update_progress(uint32_t progress, uint32_t total);
00042 
00043 /**
00044  * @brief Set the cloud client instance for the update UI to use
00045  * @param[in] client pointer to the cloud client instance
00046  */
00047 void update_ui_set_cloud_client(MbedCloudClient* client);
00048 
00049 
00050 #endif // MBED_CLOUD_CLIENT_SUPPORT_UPDATE
00051 
00052 #endif // UPDATE_UI_EXAMPLE_H