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

Базовый класс для всех пакетов, принятых по эфиру и передаваемых модулем на UART. Подробнее...

#include <SerialStar.h>

Граф наследования:RxCommonResponse:
MBeeResponse RemoteAtCommandResponse RxAcknowledgeResponse RxDataResponse RxIoSampleResponse RxResponse

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

 RxCommonResponse ()
 Конструктор "по умолчанию".
 
uint16_t getRemoteAddress ()
 Возвращает адрес модема, источника данных.
 
uint8_t getRssi ()
 Возвращает RSSI на антенном входе модуля, зафиксированный в момент приема пакета. Подробнее...
 
uint8_t getOption ()
 Возвращает байт опций.
 
uint8_t getFrameId ()
 Возвращает frameId в случае приема пакета расширенного формата. Подробнее...
 
uint16_t getPreviousHopAddress ()
 Возвращает адрес модема, непосредственно отправившего пакет. Подробнее...
 
- Открытые члены унаследованные от 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
 

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

Базовый класс для всех пакетов, принятых по эфиру и передаваемых модулем на UART.

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

Методы

◆ getFrameId()

uint8_t RxCommonResponse::getFrameId ( )

Возвращает frameId в случае приема пакета расширенного формата.

Для стандарных пакетов, возвращает NULL.

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

281 {
283  {
284  return getFrameData()[4];
285  }
286  return 0;
287 }
uint8_t getExtendedFieldsLength(void)
Возвращает длину дополнительных полей пакета расширенного формата.
Definition: SerialStar.cpp:111
uint8_t * getFrameData()
Возвращает указатель на буфер, который содержит сообщение.
Definition: SerialStar.cpp:96

◆ getPreviousHopAddress()

uint16_t RxCommonResponse::getPreviousHopAddress ( )

Возвращает адрес модема, непосредственно отправившего пакет.

Действителен только для пакетоа расширенного формата. В случае приема стандартного пакета возвращает NULL.

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

290 {
292  {
293  return(getFrameData()[5] << 8) + getFrameData()[6];
294  }
295  return 0;
296 }
uint8_t getExtendedFieldsLength(void)
Возвращает длину дополнительных полей пакета расширенного формата.
Definition: SerialStar.cpp:111
uint8_t * getFrameData()
Возвращает указатель на буфер, который содержит сообщение.
Definition: SerialStar.cpp:96

◆ getRssi()

uint8_t RxCommonResponse::getRssi ( )

Возвращает RSSI на антенном входе модуля, зафиксированный в момент приема пакета.

Число со знаком в дополнительном коде.

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

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

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