|
| 1 | +/* |
| 2 | + * Copyright (c) 2018, Arm Limited and affiliates. |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + * |
| 5 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + * you may not use this file except in compliance with the License. |
| 7 | + * You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | + |
| 18 | +#ifndef GENERIC_AT3GPP_H_ |
| 19 | +#define GENERIC_AT3GPP_H_ |
| 20 | + |
| 21 | +#include "AT_CellularDevice.h" |
| 22 | + |
| 23 | +namespace mbed { |
| 24 | + |
| 25 | +/** |
| 26 | + * Generic Cellular module which can be used as a default module when porting new cellular module. |
| 27 | + * GENERIC_AT3GPP uses standard 3GPP AT commands (3GPP TS 27.007 V14.5.0 (2017-09)) to communicate with the modem. |
| 28 | + * |
| 29 | + * GENERIC_AT3GPP can be used as a shield for example on top K64F. |
| 30 | + * Cellular example can be used for testing: https://github.com/ARMmbed/mbed-os-example-cellular |
| 31 | + * Add line to mbed_app.json where you define this class as CELLULAR_DEVICE and the correct pins. In cellular example |
| 32 | + * line would be for example just above "target_overrides": {... |
| 33 | + * For example: |
| 34 | + * "macros": ["CELLULAR_DEVICE=GENERIC_AT3GPP", "MDMRXD=PTC16", "MDMTXD=PTC17","MDMRTS=NC", "MDMCTS=NC"], |
| 35 | + * You can define CELLULAR_DEVICE and pins also in ../../../common/CellularTargets.h |
| 36 | + * |
| 37 | + * If new target don't work with GENERIC_AT3GPP then it needs some customizations. |
| 38 | + * First thing to try can be checking/modifying cellular_properties array in GENERIC_AT3GPP.cpp, does the module support |
| 39 | + * these commands or not? Modify array and if that's not enough then some AT_xxx classes might need to be created and |
| 40 | + * methods overridden. Check help how other modules are done what methods they have overridden. Happy porting! |
| 41 | + */ |
| 42 | +class GENERIC_AT3GPP : public AT_CellularDevice { |
| 43 | +public: |
| 44 | + GENERIC_AT3GPP(FileHandle *fh); |
| 45 | + virtual ~GENERIC_AT3GPP(); |
| 46 | + |
| 47 | +}; |
| 48 | +} // namespace mbed |
| 49 | +#endif // GENERIC_AT3GPP_H_ |
0 commit comments