Mistake on this page?
Report an issue in GitHub or email us
AT_CellularInformation.h
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 AT_CELLULAR_INFORMATION_H_
19 #define AT_CELLULAR_INFORMATION_H_
20 
21 #include "CellularInformation.h"
22 #include "ATHandler.h"
23 #include "AT_CellularDevice.h"
24 
25 namespace mbed {
26 
27 /**
28  * Class AT_CellularInformation
29  *
30  * Class that provides information about cellular device.
31  */
33 public:
35 
36  virtual ~AT_CellularInformation();
37 
38 public:
39  virtual nsapi_error_t get_manufacturer(char *buf, size_t buf_size);
40 
41  virtual nsapi_error_t get_model(char *buf, size_t buf_size);
42 
43  virtual nsapi_error_t get_revision(char *buf, size_t buf_size);
44 
45  virtual nsapi_error_t get_serial_number(char *buf, size_t buf_size, SerialNumberType type);
46 
47  virtual nsapi_error_t get_imsi(char *imsi, size_t buf_size);
48 
49  virtual nsapi_error_t get_iccid(char *buf, size_t buf_size);
50 
51 protected:
52  /** Request information text from cellular device
53  *
54  * @param cmd 3gpp command string
55  * @param buf buffer for response
56  * @param buf_size buffer size
57  * @return on success read character count, on failure negative error code
58  */
59  nsapi_error_t get_info(const char *cmd, char *buf, size_t buf_size);
60 
61 protected:
62  ATHandler &_at;
63  AT_CellularDevice &_device;
64 };
65 
66 } // namespace mbed
67 
68 #endif // AT_CELLULAR_INFORMATION_H_
virtual nsapi_error_t get_model(char *buf, size_t buf_size)
Request model identification of cellular device.
virtual nsapi_error_t get_revision(char *buf, size_t buf_size)
Request revision identification of cellular device.
SerialNumberType
Request serial number identification of cellular device.
signed int nsapi_error_t
Type used to represent error codes.
Definition: nsapi_types.h:95
virtual nsapi_error_t get_iccid(char *buf, size_t buf_size)
Get serial number from the SIM card.
nsapi_error_t get_info(const char *cmd, char *buf, size_t buf_size)
Request information text from cellular device.
virtual nsapi_error_t get_manufacturer(char *buf, size_t buf_size)
Request manufacturer identification of cellular device.
Class CellularInformation.
Class AT_CellularInformation.
virtual nsapi_error_t get_imsi(char *imsi, size_t buf_size)
Get IMSI from the sim card.
Class AT_CellularDevice.
Definition: ATHandler.h:46
Class for sending AT commands and parsing AT responses.
Definition: ATHandler.h:70
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.