AT_CellularPower.h

00001 /*
00002  * Copyright (c) 2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef AT_CELLULAR_POWER_H_
00019 #define AT_CELLULAR_POWER_H_
00020 
00021 #include "CellularPower.h"
00022 #include "AT_CellularBase.h"
00023 
00024 namespace mbed {
00025 
00026 /**
00027  *  Class AT_CellularPower
00028  *
00029  *  Class that provides power handling functions for modem/module.
00030  */
00031 class AT_CellularPower : public CellularPower, public AT_CellularBase {
00032 public:
00033     AT_CellularPower(ATHandler &atHandler);
00034     virtual ~AT_CellularPower();
00035 
00036 public:
00037     virtual nsapi_error_t on();
00038 
00039     virtual nsapi_error_t off();
00040 
00041     virtual nsapi_error_t set_at_mode();
00042 
00043     virtual nsapi_error_t set_power_level(int func_level, int do_reset = 0);
00044 
00045     virtual nsapi_error_t reset();
00046 
00047     virtual nsapi_error_t opt_power_save_mode(int periodic_time, int active_time);
00048 
00049     virtual nsapi_error_t opt_receive_period(int mode, EDRXAccessTechnology act_type, uint8_t edrx_value);
00050 
00051     virtual nsapi_error_t is_device_ready();
00052 
00053     virtual nsapi_error_t set_device_ready_urc_cb(mbed::Callback<void()> callback);
00054 
00055     virtual void remove_device_ready_urc_cb(mbed::Callback<void()> callback);
00056 };
00057 
00058 } // namespace mbed
00059 
00060 #endif /* AT_CELLULAR_POWER_H_ */