MBee Arduino library
Открытые члены | Полный список членов класса
Класс RxIoSampleResponse
Граф наследования:RxIoSampleResponse:
RxDataResponse RxCommonResponse MBeeResponse

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

 RxIoSampleResponse ()
 Конструктор "по умолчанию".
 
uint8_t getDataLength ()
 Возвращает длину поля данных, не включая 2 байт с температурой и напряжением источника питания удаленного модема.
 
uint8_t getDataOffset ()
 Возвращает номер байта в принятом пакете с которого начинается поле данных.
 
uint8_t getSampleSize ()
 Возвращает число линий ввода/вывода данные о текущем состоянии которых имеются в принятом пакете.
 
uint8_t getTemperature ()
 Возвращает температуру, измеренную на удаленном модеме. Подробнее...
 
uint8_t getVbatt ()
 Возвращает напряжение источника питания удаленного модема. Подробнее...
 
uint8_t getMode (uint8_t number)
 Возвращает режим линии ввода/ввода по порядковому номеру выборки в принятом пакете.
 
uint8_t getPin (uint8_t number)
 Возвращает номер вывода модуля, соответствующий порядковому номеру выборки в принятом пакете.
 
bool isAvailable (uint8_t pin)
 Возвращает true, если информация о текущем состоянии данного вывода модуля имеется в принятом пакете.
 
uint8_t getSampleNumber (uint8_t pin)
 Возвращает порядковый номер выборки в принятом пакете, в котором содержится информация о текущем состоянии данного вывода модуля. Подробнее...
 
uint16_t getAnalog (uint8_t number)
 Возвращает текущее состояние аналогового входа, соответствующего порядковому номеру выборки в принятом пакете.
 
uint8_t getDigital (uint8_t number)
 Возвращает текущее состояние цифрового входа/выхода, соответствующего порядковому номеру выборки в принятом пакете.
 
uint32_t getCounter (uint8_t number)
 Возвращает число подсчитанных импульсов для счетного входа, соответствующего порядковому номеру выборки в принятом пакете.
 
- Открытые члены унаследованные от RxDataResponse
 RxDataResponse ()
 Конструктор "по умолчанию".
 
uint8_t getData (uint8_t index)
 Возвращает байт из поля данных принятого пакета в соответствии с номером, определяемом переменной index. Подробнее...
 
uint8_t * getData ()
 Возвращает указатель на поле данных принятого пакета.
 
bool isAddressBroadcast ()
 Возвращает true, если принятый пакет был широковещательный.
 
- Открытые члены унаследованные от RxCommonResponse
 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
 

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

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

Методы

◆ getSampleNumber()

uint8_t RxIoSampleResponse::getSampleNumber ( uint8_t  pin)

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

Если информация для данного вывода отсутствует в принятом пакете, то возвращается 0. Может использоваться вместо метода isAvailable.

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

486 {
487  for(uint8_t i = 1; i <= getSampleSize(); i++)
488  {
489  if(getPin(i) == pin)
490  return i;
491  }
492  return 0;
493 }
uint8_t getSampleSize()
Возвращает число линий ввода/вывода данные о текущем состоянии которых имеются в принятом пакете...
Definition: SerialStar.cpp:442
uint8_t getPin(uint8_t number)
Возвращает номер вывода модуля, соответствующий порядковому номеру выборки в принятом пакете...
Definition: SerialStar.cpp:470

◆ getTemperature()

uint8_t RxIoSampleResponse::getTemperature ( )

Возвращает температуру, измеренную на удаленном модеме.

Температура измеряется с помощью встроенного датчика. Значение представляет собой число в дополнительном коде со знаком. Если число меньше, чем 128, то это и есть текущая температура. Если число больше 128-и, то его нужно вычесть из 256 и поменять знак.

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

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

◆ getVbatt()

uint8_t RxIoSampleResponse::getVbatt ( )

Возвращает напряжение источника питания удаленного модема.

Для расчета значения напряжения в вольтах, необходимо полученное число разделить на 51.

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

461 {
462  return getFrameData()[5 + getExtendedFieldsLength()];
463 }
uint8_t getExtendedFieldsLength(void)
Возвращает длину дополнительных полей пакета расширенного формата.
Definition: SerialStar.cpp:111
uint8_t * getFrameData()
Возвращает указатель на буфер, который содержит сообщение.
Definition: SerialStar.cpp:96

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