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_1 {
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 
29  enumeration SimSecurityStatus {
33  UNKNOWN
34  };
35 
40  structure Settings {
41  string pin;
42  string smsc;
43  };
45 
50  structure Information {
51  string imei;
52  string imsi;
53 
54  string manufacturer;
55  string model;
56  string revision;
57 
58  string ownNumber;
59  string simSmsc;
60  string networkName;
63  };
65 
69  valueobject SimSecurityStatusChangedEvent extends idl.Event {
70  SimSecurityStatus newSimStatus;
71  };
72 
76  valueobject SimPinUpdatedEvent extends idl.Event {
77  string newPin;
78  };
79 
85  Settings getSettings();
86 
95  int setSettings(in Settings settings);
96 
109  int sendSms(in string recipient, in string text);
110 
125  int sendTestSms(in string recipient, in Settings testSettings);
126 
137  int getInformation(out Information info);
138 
151  int getInformationWithPin(in string pin, out Information info);
152 
161  int getSimSecurityStatus(out SimSecurityStatus simStatus);
162 
175  int unlockSimCard(in string puk, in string newPin);
176  };
177 
178 }
179 
180 #endif /* __GSMMODEM_IDL__ */
string manufacturer
modem manufacturer string
Definition: GsmModem.idl:54
PUK and new PIN must be entered to unlock the SIM card.
Definition: GsmModem.idl:32
Structure for holding settings of the GSM modem and its SIM card.
Definition: GsmModem.idl:40
Interface for communication with a GSM modem attached to a serial port.
Definition: GsmModem.idl:13
string simSmsc
SMS center number stored on SIM card.
Definition: GsmModem.idl:59
string model
modem model string
Definition: GsmModem.idl:55
string imsi
IMSI of the SIM card.
Definition: GsmModem.idl:52
string imei
IMEI of the modem.
Definition: GsmModem.idl:51
string serviceProviderName
Name of the service provider (SPN)
Definition: GsmModem.idl:61
Serial Ports.
Definition: AnalogModem.idl:7
Basic IDL definitions.
Definition: Event.idl:6
Structure holding information about the modem and the SIM card.
Definition: GsmModem.idl:50
string networkName
Name of the currently used network (PLMN)
Definition: GsmModem.idl:60
string revision
modem revision string
Definition: GsmModem.idl:56
int receptionLevel
reception level in dBm 0 means unknown, -1 means no reception
Definition: GsmModem.idl:62
string pin
PIN of the SIM card.
Definition: GsmModem.idl:41
SimSecurityStatus
Possible security states the sim card can be in at a given time.
Definition: GsmModem.idl:29
PIN must be entered to unlock the SIM card.
Definition: GsmModem.idl:31
string smsc
Custom SMS center number (in ITU-T E.164 format), leave empty to use number stored on SIM card...
Definition: GsmModem.idl:42
SIM card is unlocked.
Definition: GsmModem.idl:30
string ownNumber
own phone number in ITU-T E.164 format
Definition: GsmModem.idl:58