GENERIC_AT3GPP.h

00001 /*
00002  * Copyright (c) 2018, 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 GENERIC_AT3GPP_H_
00019 #define GENERIC_AT3GPP_H_
00020 
00021 #ifdef TARGET_FF_ARDUINO
00022 #ifndef MBED_CONF_GENERIC_AT3GPP_TX
00023 #define MBED_CONF_GENERIC_AT3GPP_TX D1
00024 #endif
00025 #ifndef MBED_CONF_GENERIC_AT3GPP_RX
00026 #define MBED_CONF_GENERIC_AT3GPP_RX D0
00027 #endif
00028 #endif /* TARGET_FF_ARDUINO */
00029 
00030 #include "AT_CellularDevice.h"
00031 
00032 namespace mbed {
00033 
00034 /**
00035  * Generic Cellular module which can be used as a default module when porting new cellular module.
00036  * GENERIC_AT3GPP uses standard 3GPP AT commands (3GPP TS 27.007 V14.5.0 (2017-09)) to communicate with the modem.
00037  *
00038  * GENERIC_AT3GPP can be used as a shield for example on top K64F.
00039  * Cellular example can be used for testing: https://github.com/ARMmbed/mbed-os-example-cellular
00040  * Define in mbed_app.json "target_overrides" correct pins and other setup for your modem.
00041  *
00042  * If new target don't work with GENERIC_AT3GPP then it needs some customizations.
00043  * First thing to try can be checking/modifying cellular_properties array in GENERIC_AT3GPP.cpp, does the module support
00044  * these commands or not? Modify array and if that's not enough then some AT_xxx classes might need to be created and
00045  * methods overridden. Check help how other modules are done what methods they have overridden. Happy porting!
00046  */
00047 class GENERIC_AT3GPP : public AT_CellularDevice {
00048 public:
00049     GENERIC_AT3GPP(FileHandle *fh);
00050 };
00051 } // namespace mbed
00052 #endif // GENERIC_AT3GPP_H_