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

Класс для ответа на локальный командный API-фрейм. Подробнее...

#include <SerialStar.h>

Граф наследования:AtCommandResponse:
FrameIdResponse MBeeResponse

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

 AtCommandResponse ()
 Конструктор "по умолчанию".
 
uint8_t * getCommand ()
 Возвращает указатель на массив, содержащий 2 ASCII символа AT-команды.
 
uint8_t getStatus ()
 Возвращает статус команды. Подробнее...
 
uint8_t * getValue ()
 Возвращает указатель на массив, содержащий параметр команды. Подробнее...
 
uint8_t getValueLength ()
 Возвращает длину поля параметра команды.
 
bool isOk ()
 Возвращает true, если статус эквивалентен AT_OK.
 
- Открытые члены унаследованные от FrameIdResponse
 FrameIdResponse ()
 Конструктор "по умолчанию".
 
uint8_t getFrameId ()
 Возвращает идентификатор фрейма.
 
- Открытые члены унаследованные от MBeeResponse
 MBeeResponse ()
 Конструктор "по умолчанию".
 
uint8_t getApiId ()
 Возвращает тип API-фрейма.
 
void setApiId (uint8_t apiId)
 
uint8_t getMsbLength ()
 Возвращает MSB длины поля данных.
 
void setMsbLength (uint8_t msbLength)
 
uint8_t getLsbLength ()
 Возвращает LSB длины поля данных.
 
void setLsbLength (uint8_t lsbLength)
 
uint8_t getChecksum ()
 Подсчет контрольной суммы.
 
void setChecksum (uint8_t checksum)
 Запись контрольной суммы в соответствующее поле пакета.
 
uint8_t getFrameDataLength ()
 Возвращает длину данных в пакете между полем типа API-фрейма и контрольной суммой.
 
void setFrameLength (uint8_t frameLength)
 Запись поля длины в пакете.
 
void setFrameData (uint8_t *frameDataPtr)
 Устанавливает указатель на поле данных пакета.
 
uint8_t * getFrameData ()
 Возвращает указатель на буфер, который содержит сообщение. Подробнее...
 
uint16_t getPacketLength ()
 Возвращает длину пакета.
 
void setExtendedFieldsLength (uint8_t length)
 Устанавливает длину дополнительных полей пакета расширенного формата. Подробнее...
 
uint8_t getExtendedFieldsLength (void)
 Возвращает длину дополнительных полей пакета расширенного формата.
 
void reset ()
 Сбрасывает все поля пакета.
 
void init ()
 Инициализация пакета.
 
void getTxStatusResponse (MBeeResponse &response)
 Вызов TxStatusResponse при getApiId() == 0x8B.
 
void getRxResponse (MBeeResponse &response)
 Вызов RxResponse при getApiId() == 0x81, 0x82, 0x8F, 0x90.
 
void getRxIoSampleResponse (MBeeResponse &response)
 Вызов RxIoSampleResponse при getApiId() == 0x83, 0x84.
 
void getModemStatusResponse (MBeeResponse &response)
 Вызов ModemStatusResponse при getApiId() == 0x8A.
 
void getAtCommandResponse (MBeeResponse &responses)
 Вызов AtCommandResponse при getApiId() == x88).
 
void getRemoteAtCommandResponse (MBeeResponse &response)
 Вызов RemoteAtCommandResponse при getApiId() == 0x97, 0x98.
 
void getRxAcknowledgeResponse (MBeeResponse &response)
 Вызов RxAcknowledgeResponse при getApiId() == 0x8C.
 
bool isAvailable ()
 Возвращает true, если пакет успешно принят.
 
void setAvailable (bool complete)
 Устанавливает признак доступности пакета.
 
bool isError ()
 Возвращает true если при разборе пакета произошли ошибки.
 
uint8_t getErrorCode ()
 Возвращает код ошибки или 0, если их нет. Подробнее...
 
void setErrorCode (uint8_t errorCode)
 Устанавливает код ошибки.
 

Дополнительные унаследованные члены

- Защищенные данные унаследованные от MBeeResponse
uint8_t * _frameDataPtr
 

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

Класс для ответа на локальный командный API-фрейм.

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

Методы

◆ getStatus()

uint8_t AtCommandResponse::getStatus ( )

Возвращает статус команды.

Если 0, значит команда выполнена успешно.

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

312 {
313  return getFrameData()[3];
314 }
uint8_t * getFrameData()
Возвращает указатель на буфер, который содержит сообщение.
Definition: SerialStar.cpp:96

◆ getValue()

uint8_t * AtCommandResponse::getValue ( )

Возвращает указатель на массив, содержащий параметр команды.

Применяется только для команд запроса.

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

322 {
323  if(getValueLength() > 0)
324  {
325  return getFrameData() + 4; //Поле параметра включается только для команд запроса. Команды устанвоки не имеют в ответе поля параметра.
326  }
327  return NULL;
328 }
uint8_t getValueLength()
Возвращает длину поля параметра команды.
Definition: SerialStar.cpp:316
uint8_t * getFrameData()
Возвращает указатель на буфер, который содержит сообщение.
Definition: SerialStar.cpp:96

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