mirror of https://github.com/ARMmbed/mbed-os.git
74 lines
2.4 KiB
C++
74 lines
2.4 KiB
C++
/*
|
|
* Copyright (c) 2017, Arm Limited and affiliates.
|
|
* 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 AT_CELLULAR_BASE_H_
|
|
#define AT_CELLULAR_BASE_H_
|
|
|
|
#include "ATHandler.h"
|
|
|
|
namespace mbed {
|
|
|
|
/**
|
|
* Class AT_CellularBase
|
|
*
|
|
* A base class for AT-classes.
|
|
*/
|
|
class AT_CellularBase {
|
|
public:
|
|
AT_CellularBase(ATHandler &at);
|
|
|
|
/** Getter for at handler. Common method for all AT-classes.
|
|
*
|
|
* @return reference to ATHandler
|
|
*/
|
|
ATHandler &get_at_handler();
|
|
|
|
/** Gets the device error that happened when using AT commands/responses. This is at error
|
|
* returned by the device. Returned CME/CMS errors can be found from 3gpp documents 27007 and 27005.
|
|
*
|
|
* @return at error (CME/CMS) while communicating with the device
|
|
*/
|
|
device_err_t get_device_error() const;
|
|
|
|
/** Cellular module need to define an array of unsupported features if any,
|
|
* by default all features are supported.
|
|
*
|
|
* @param features Array of type SupportedFeature with last element FEATURE_END_MARK
|
|
*/
|
|
enum SupportedFeature {
|
|
AT_CGSN_WITH_TYPE, // AT+CGSN without type is likely always supported similar to AT+GSN
|
|
AT_CGDATA, // alternative is to support only ATD*99***<cid>#
|
|
SUPPORTED_FEATURE_END_MARK // must be last element in the array of features
|
|
};
|
|
static void set_unsupported_features(const SupportedFeature *unsupported_features);
|
|
|
|
protected:
|
|
ATHandler &_at;
|
|
|
|
/** Check if some functionality is supported by a cellular module. For example,
|
|
* most of standard AT commands are optional and not implemented by all cellular modules.
|
|
*
|
|
* @param feature check for feature to support
|
|
* @return true on supported, otherwise false
|
|
*/
|
|
static const SupportedFeature *_unsupported_features;
|
|
static bool is_supported(SupportedFeature feature);
|
|
};
|
|
|
|
} // namespace mbed
|
|
|
|
#endif /* AT_CELLULAR_BASE_H_ */
|