MBee Arduino library
Открытые члены | Полный список членов класса
Класс RemoteAtCommandRequest

Класс для удаленного управления модулем с помощью API-фрейма. Подробнее...

#include <SerialStar.h>

Граф наследования:RemoteAtCommandRequest:
AtCommandRequest MBeeRequest

Открытые члены

 RemoteAtCommandRequest ()
 Конструктор "по умолчанию".
 
 RemoteAtCommandRequest (uint16_t remoteAddress, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength)
 Создает команду установки параметра на удаленном модеме с установленными значением параметра и полем его длины. Подробнее...
 
 RemoteAtCommandRequest (uint16_t remoteAddress, uint8_t *command)
 Создает команду запроса параметра на требуемом удаленном модеме. Подробнее...
 
uint16_t getRemoteAddress ()
 
void setRemoteAddress (uint16_t remoteAddress)
 
bool getAcknowledge ()
 
void setAcknowledge (bool acknowledge)
 
bool getApplyChanges ()
 
void setApplyChanges (bool applyChanges)
 
bool getSaveChanges ()
 
void setSaveChanges (bool saveChanges)
 
bool getCca ()
 
void setCca (bool cca)
 
bool getEncryption ()
 
void setEncryption (bool encryption)
 
bool getSleepingDevice ()
 
void setSleepingDevice (bool sleepingDevice)
 
uint8_t getFrameData (uint8_t pos)
 Возвращает в зависимости о номера байта либо код AT-команды, содержащейся в фрейме, либо байта параметра команды.
 
uint8_t getFrameDataLength ()
 Возвращает длину командного фрейма команды.
 
void setDefault ()
 
- Открытые члены унаследованные от AtCommandRequest
 AtCommandRequest ()
 Конструктор "по умолчанию".
 
 AtCommandRequest (uint8_t *command)
 Создает локальный командный API-фрейм с заданным кодом команды.
 
 AtCommandRequest (uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength)
 Создает локальный командный API-фрейм для установки параметра с заданным кодом команды, значением параметра и длиной поля параметра команды.
 
 AtCommandRequest (uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength, uint8_t frameId)
 Создает локальный командный API-фрейм для установки паарметра с заданным кодом команды, значением параметра, длиной поля параметра команды и идентификатором фрейма.
 
uint8_t * getCommand ()
 Возвращает указатель на байты с кодом команды.
 
void setCommand (uint8_t *command)
 Устанавливает команду по указателю на байты на кода.
 
uint8_t * getCommandValue ()
 Возвращает указатель на первый байт параметра команды.
 
void setCommandValue (uint8_t *value)
 Устанавливает указатель на первый байт параметра команды.
 
uint8_t getCommandValueLength ()
 Возвращает длину поля параметра команды.
 
void setCommandValueLength (uint8_t length)
 Устанавливает длину поля параметра команды.
 
void clearCommandValue ()
 Присваивает указателю на поле кода команды значение NULL и обнуляет поле длины параметра команды.
 
- Открытые члены унаследованные от MBeeRequest
 MBeeRequest (uint8_t apiId, uint8_t frameId)
 Конструктор, создающий фрейм с заданным API ID и идентификатором.
 
void setFrameId (uint8_t frameId)
 Устанавливает frame id. Подробнее...
 
uint8_t getFrameId ()
 Возвращает frame id.
 
void setApiId (uint8_t apiId)
 Устанавливает тип API-фрейма.
 
uint8_t getApiId ()
 Возвращает тип API-фрейма.
 

Подробное описание

Класс для удаленного управления модулем с помощью API-фрейма.

См. определение в файле SerialStar.h строка 872

Конструктор(ы)

◆ RemoteAtCommandRequest() [1/2]

RemoteAtCommandRequest::RemoteAtCommandRequest ( uint16_t  remoteAddress,
uint8_t *  command,
uint8_t *  commandValue,
uint8_t  commandValueLength 
)

Создает команду установки параметра на удаленном модеме с установленными значением параметра и полем его длины.

По умолчанию устанавливаются следущие параметры отправки:

  1. Подтверждение доставки включено.
  2. Измененное значение параметра на удаленном модуле автоматически применяется и сохраняется в энергонезависимой памяти.
  3. Команда отправляется в режиме CCA (Clear Channel Assessment).
  4. Шифрование выключено.
  5. Команда предназначается для модема, находящегося а активном режиме (команда отправляется сразу после получения, а не помещается в буфер.

См. определение в файле SerialStar.cpp строка 737

737  : AtCommandRequest(command, commandValue, commandValueLength)
738 {
739  _remoteAddress = remoteAddress;
740  _acknowledge = true;
741  _applyChanges = true;
742  _saveChanges = true;
743  _cca = true;
744  _encryption = false;
745  _sleepingDevice = false;
746  setApiId(REMOTE_AT_COMMAND_REQUEST_API_FRAME);
747 }
AtCommandRequest()
Конструктор "по умолчанию".
Definition: SerialStar.cpp:610
void setApiId(uint8_t apiId)
Устанавливает тип API-фрейма.
Definition: SerialStar.cpp:602

◆ RemoteAtCommandRequest() [2/2]

RemoteAtCommandRequest::RemoteAtCommandRequest ( uint16_t  remoteAddress,
uint8_t *  command 
)

Создает команду запроса параметра на требуемом удаленном модеме.

По умолчанию устанавливаются следущие параметры отправки:

  1. Подтверждение доставки включено.
  2. Команда отправляется в режиме CCA (Clear Channel Assessment).
  3. Шифрование выключено.
  4. Команда предназначается для модема, находящегося а активном режиме (команда отправляется сразу после получения, а не помещается в буфер.

См. определение в файле SerialStar.cpp строка 749

749  : AtCommandRequest(command, NULL, 0)
750 {
751  _remoteAddress = remoteAddress;
752  _acknowledge = true;
753  _applyChanges = true;
754  _saveChanges = true;
755  _cca = true;
756  _encryption = false;
757  _sleepingDevice = false;
758  setApiId(REMOTE_AT_COMMAND_REQUEST_API_FRAME);
759 }
AtCommandRequest()
Конструктор "по умолчанию".
Definition: SerialStar.cpp:610
void setApiId(uint8_t apiId)
Устанавливает тип API-фрейма.
Definition: SerialStar.cpp:602

Объявления и описания членов классов находятся в файлах: