Raritan PX2/PX3 JSON-RPC API
GsmModem.idl
1 #ifndef __GSMMODEM_IDL__
2 #define __GSMMODEM_IDL__
3 
4 #include <Event.idl>
5 
7 module serial {
8 
13  interface GsmModem_1_0_2 {
17  constant int SUCCESS = 0;
18  constant int ERR_INVALID_VALUE = 1;
19  constant int ERR_WRONG_PIN = 2;
20  constant int ERR_SMS_SEND_FAILED = 3;
21  constant int ERR_COMMUNICATION_FAILURE = 4;
22  constant int ERR_SIM_LOCKED = 5;
23  constant int ERR_WRONG_SIM_STATUS = 6;
24  constant int ERR_WRONG_PUK = 7;
25  constant int ERR_SIM_PROBLEM = 8;
26 
30  enumeration SimSecurityStatus {
34  UNKNOWN
35  };
36 
41  structure Settings {
42  string pin;
43  string smsc;
44  };
46 
51  structure Information {
52  string imei;
53  string imsi;
54 
55  string manufacturer;
56  string model;
57  string revision;
58 
59  string ownNumber;
60  string simSmsc;
61  string networkName;
64  };
66 
70  valueobject SimSecurityStatusChangedEvent extends idl.Event {
71  SimSecurityStatus newSimStatus;
72  };
73 
77  valueobject SimPinUpdatedEvent extends idl.Event {
78  string newPin;
79  };
80 
86  Settings getSettings();
87 
96  int setSettings(in Settings settings);
97 
110  int sendSms(in string recipient, in string text);
111 
126  int sendTestSms(in string recipient, in Settings testSettings);
127 
138  int getInformation(out Information info);
139 
152  int getInformationWithPin(in string pin, out Information info);
153 
162  int getSimSecurityStatus(out SimSecurityStatus simStatus);
163 
176  int unlockSimCard(in string puk, in string newPin);
177  };
178 
179 }
180 
181 #endif /* __GSMMODEM_IDL__ */
PUK and new PIN must be entered to unlock the SIM card.
Definition: GsmModem.idl:33
string pin
PIN of the SIM card.
Definition: GsmModem.idl:42
string serviceProviderName
Name of the service provider (SPN)
Definition: GsmModem.idl:62
string networkName
Name of the currently used network (PLMN)
Definition: GsmModem.idl:61
Interface for communication with a GSM modem attached to a serial port.
Definition: GsmModem.idl:13
string revision
modem revision string
Definition: GsmModem.idl:57
SIM card is unlocked.
Definition: GsmModem.idl:31
string imei
IMEI of the modem.
Definition: GsmModem.idl:52
Serial Ports.
Definition: AnalogModem.idl:7
PIN must be entered to unlock the SIM card.
Definition: GsmModem.idl:32
Basic IDL definitions.
Definition: Event.idl:6
Structure holding information about the modem and the SIM card.
Definition: GsmModem.idl:51
string model
modem model string
Definition: GsmModem.idl:56
int receptionLevel
reception level in dBm 0 means unknown, -1 means no reception
Definition: GsmModem.idl:63
string manufacturer
modem manufacturer string
Definition: GsmModem.idl:55
string simSmsc
SMS center number stored on SIM card.
Definition: GsmModem.idl:60
string imsi
IMSI of the SIM card.
Definition: GsmModem.idl:53
Structure for holding settings of the GSM modem and its SIM card.
Definition: GsmModem.idl:41
SimSecurityStatus
Possible security states the sim card can be in at a given time.
Definition: GsmModem.idl:30
string smsc
Custom SMS center number (in ITU-T E.164 format), leave empty to use number stored on SIM card...
Definition: GsmModem.idl:43
string ownNumber
own phone number in ITU-T E.164 format
Definition: GsmModem.idl:59