Служба GSM предназначена для управления системой мониторинга посредством SMS, организации SMS рассылок и отправки SMS уведомлений при срабатывании логических схем.
Управление GSM возможно при наличии разрешения "gsm" в профиле пользователя, выполняющего запрос.
Для управления используются следующие значения поля querytype:
getelement - получить параметры элемента GSM modem, дополнительные поля:
- id - идентификатор элемента GSM modem;
period - необязательный, при наличии выдается список SMS за указанный период, возможные значения:
'100seconds' - 100 последних секунд;
'100minutes' - 100 последних минут;
- '100hours' - 100 последних часов;
- '100days' - 100 последних дней;
Пример ответа на запрос getelement для элемента GSM модем<element id="1010" module="16" clas="devhwr" type="GSM modem" state="normal" name="GSM Modem TELE2" value="51" imei="861785001227689" pin="0000" sms_centre="89537300611" allowed="+79206355186" status="found, ready" verbosity="7" > <balance phone="*105#" text="" t="0" /> <operators current="TELE2" status="registered" signal="-81" > <operator id="0" status="current" name="TELE2" /> <operator id="1" status="available" name="MegaFon RUS" /> <operator id="2" status="available" name="Beeline" /> <operator id="3" status="available" name="RUS DTC" /> <operator id="4" status="available" name="MTS-RUS" /> </operators> <smslist period="100days"> <sms id="0" state="send" to_phone="000100" message="test1" t="1398585756" /> <sms id="1" state="send" to_phone="000100" message="test2" t="1398585761" /> <sms id="2" state="send" to_phone="000100" message="test3" t="1398585817" /> <sms id="3" state="send" to_phone="000100" message="test4" t="1398585824" /> </smslist> </element>
Описание узлов xml:
- element - свойства элемента GSM modem:
- id - идентификатор;
- module - идентификатор модуля;
- clas - класс устройства;
- type - тип устройства;
- state - состояние:
- 'normal' - модем готов к отправке SMS;
- 'alarm' - внутренняя ошибка.
- name - имя устройства;
- value - уровень сигнала модема в %;
- imei - международный идентификатор мобильного оборудования;
- pin - PIN-код SIM-карты;
- sms_centre - номер SMS-центра;
- allowed - список номеров, с которых разрешен прием SMS-команд, разделение номеров через пробел ' ';
- status - текущее состояние модема:
- 'initialization' - инициализация модема;
- 'found, initialization' - модем найден, продолжение инициализации;
- 'turn on time out' - таймаут ожидания включения модема;
- 'found, ready' - модем готов к работе;
- 'found, not ready' - модем не готов или неисправен;
- 'SIM-card not inserted' - ошибка установки SIM-карты;
- 'PIN code required' - требуется PIN-код;
- 'PIN code invalid' - PIN-код неверный;
- 'PIN code length incorrect' - длина PIN-кода неправильная;
- 'PIN code must be digit' - PIN-код должен состоять только из цифр;
- 'PUK code required' - PIN-код заблокирован, требуется ввести PUK-код;
- 'SMS Center number incorrect' - номер SMS-центра некорректный;
- 'error sending SMS' - ошибка отправки SMS;
- 'command maximum repeated' - максимальное количество попыток отправки AT-команды;
- 'reset modem' - перезапуск модема;
- 'number of resets is exceeded' - максимальное количество попыток перезапуска;
- 'modem turn off' - питание на модеме отключено;
- verbosity - уровень отладочной информации (подробнее в описании updateelement);
balance - узел информации о балансе, выдается только при установленном номере баланса, после обновления баланса командой с полями querytype="updateelement" и ctrl="updatebalance" для элемента GSM Modem; атрибуты:
phone - номер службы баланса;
text - текст ответа на запрос о балансе;
t - время получения информации о балансе в UTS;
- operators - список операторов сети, выдается только после обновления списка операторов командой с полями querytype="updateelement" и ctrl="updateoperators" для элемента GSM Modem, атрибуты :
current - имя текущего оператора;
status - статус в сети текущего оператора; возможные значения:
- 'registered' - зарегистрирована в сети;
- 'not registered, searching' - поиск сети;
- 'not registered, not searching' - сети не найдены;
- 'not registered' - не зарегистрирована в сети;
- 'registered roaming' - зарегистрирована в роуминге;
- 'registration denied' - регистрация запрещена.
signal - уровень сигнала в сети в dB;
- operator - доступный оператор:
- id - идентификатор оператора;
- status - статус оператора:
- 'unknown': неизвестный;
- 'available': разрешена регистрация;
- 'current': текущий оператор;
- 'forbidden': запрещена регистрация.
- name - текстовое имя оператора.
- smslist - список SMS, для отправки SMS предназначен запрос send_sms_message;
period - период ('100seconds', '100minutes', '100hours', '100days');
sms - SMS в очереди:
id - идентификатор SMS в очереди;
- state - состояние SMS:
- 'wait' - добавлено в очередь, ожидает отправки;
- 'send' - отправлено;
- 'error' - не удалось отправить.
- to_phone - телефонный номер получателя SMS;
- message - текст SMS;
- t - время добавления в очередь в UTS.
- updateelement - установить параметры GSM modem, дополнительные поля:
- id - идентификатор элемента GSM modem;
- name - имя модема;
- pin - PIN-код SIM-карты;
- sms_centre - номер SMS-центра, считывается при определении наличия SIM-карты и сохраняется только на SIM-карте;
- allowed - список номеров, с которых разрешен прием SMS-команд, разделитель - пробел;
- balance - номер, по которому запрашивается баланс, состояние счета;
- operator - ручная установка оператора сотовой связи;.
- verbosity - уровень отладочной информации (по-умолчанию 2 уровень). Возможные значения:
- уровень 0: Emergency - система не работоспособна: максимальное количество повторов АТ команд, ошибка инициализации модема, SIM-карта не вставлена, максимальное количество повторов автоматической переинециализации модема, ошибка выделения динамической памяти;
- уровень 1: Alert - необходимо срочное вмешательство: требуется ввести PIN-код, ошибка при отправке SMS;
- уровень 2: Critical - критические события: ошибка отправки АТ-команды, ошибка обработки входящего SMS, переинициализация модема, очередь SMS переполнена, список доступных операторов переполнен, успешная отправка SMS;
- уровень 3: Error - сообщения об ошибках;
- уровень 4: Warning - всевозможные предупреждения: текст и номер ошибки AT-команды, ошибка конвертации текста SMS;
- уровень 5: Notice - различные важные уведомления: версия прошивки модема;
- уровень 6: Informational - информационные сообщения: изменение номера SMS-центра, состояние регистрации в сети, успешная обработка входящего SMS;
- уровень 7: Debug - детальные отладочные сообщения, включая обмен AT-командами.
- ctrl - управление модемом, возможные значения:
- "reset" - сбросить модем;
- "clearsmslist" - очистить очередь SMS;
- "updatebalance" - обновить баланс; асинхронный, текст баланса в течение одной минуты выводится в журнал и сохраняется в атрибуте text узла balance;
- "updateoperators" - обновить список операторов;
- send_sms_message - отправка SMS через GSM-модем, параметры:
to_phone - номер телефона получателя;
- message - текст SMS.