IQRF SPI library for Arduino  Version 1.2
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
IQRFTR Class Reference

#include <IQRFTR.h>

Public Types

enum  controlStatuses { READY = 0, RESET = 1, WAIT = 2, PROG_MODE = 3 }
 
enum  types {
  TR_52D = 0, TR_58D_RJ = 1, TR_72D = 2, TR_53D = 3,
  TR_54D = 8, TR_55D = 9, TR_56D = 10, TR_76D = 11
}
 
enum  mcuTypes {
  UNKNOWN = 0, PIC16LF819 = 1, PIC16LF88 = 2, PIC16F886 = 3,
  PIC16LF1938 = 4
}
 
enum  fccStatuses { NOT_CERTIFIED = 0, CERTIFIED = 1 }
 

Public Member Functions

void reset ()
 
void enterProgramMode ()
 
void turnOn ()
 
void turnOff ()
 
uint8_t getControlStatus ()
 
void setControlStatus (uint8_t status)
 
void enableProgramFlag ()
 
void disableProgramFlag ()
 
bool getProgramFlag ()
 
void controlTask ()
 
void setInfoReadingStatus (uint8_t status)
 
uint8_t getInfoReadingStatus ()
 
void identify ()
 
uint16_t getOsVersion ()
 
uint16_t getOsBuild ()
 
uint32_t getModuleId ()
 
uint16_t getMcuType ()
 
uint16_t getModuleType ()
 
uint16_t getFccStatus ()
 
uint8_t getRawInfoData (uint8_t position)
 

Detailed Description

IQRF TR

Examples:
Get-info.ino, and Hello-world.ino.

Member Enumeration Documentation

TR control statuses

Enumerator
READY 

TR ready state.

RESET 

TR reset process.

WAIT 

TR wait state.

PROG_MODE 

TR programming mode.

FCC (Federal Communications Commission) certification statuses

Enumerator
NOT_CERTIFIED 

Not certified fy FCC.

CERTIFIED 

Certified by FCC.

TR MCU types

Enumerator
UNKNOWN 

MCU used in uknown module.

PIC16LF819 

MCU used in TR-xxx-11A not supported.

PIC16LF88 

MCU used in TR-xxx-21A.

PIC16F886 

MCU used in TR-31B, TR-52B, TR-53B.

PIC16LF1938 

MCU used in TR-52D, TR-54D.

TR module types

Enumerator
TR_52D 

TR module IQRF TR-52D.

TR_58D_RJ 

TR module IQRF TR-85D-RJ.

TR_72D 

TR module IQRF TR-72D.

TR_53D 

TR module IQRF TR-53D.

TR_54D 

TR module IQRF TR-54D.

TR_55D 

TR module IQRF TR-55D.

TR_56D 

TR module IQRF TR-56D.

TR_76D 

TR module IQRF TR-76D.

Member Function Documentation

void IQRFTR::controlTask ( )

Make TR module reset or switch to prog mode when SPI master is disabled

void IQRFTR::disableProgramFlag ( )

Disable programming flag

void IQRFTR::enableProgramFlag ( )

Enable programming flag

void IQRFTR::enterProgramMode ( )

TR module switch to programming mode

uint8_t IQRFTR::getControlStatus ( )

Get TR control status

Returns
TR control status
uint16_t IQRFTR::getFccStatus ( )

Get FCC (Federal Communications Commission) certification status

Returns
FCC (Federal Communications Commission) certification status
Examples:
Get-info.ino.
uint8_t IQRFTR::getInfoReadingStatus ( )

Get TR info reading status

Returns
TR info reading status
uint16_t IQRFTR::getMcuType ( )

Get MCU model inside TR module

Returns
MCU type
Code Type
0 unknown type
1 PIC16LF819
2 PIC16LF88
3 PIC16F886
4 PIC16LF1938
Examples:
Get-info.ino.
uint32_t IQRFTR::getModuleId ( )

Get TR module ID

Returns
Unique 32 bit identifier data word of TR module
Examples:
Get-info.ino.
uint16_t IQRFTR::getModuleType ( )

Get TR module type

Returns
TR module type
Code Model
0 TR_52D
1 TR_58D_RJ
2 TR_72D
8 TR_54D
9 TR_55D
10 TR_56D
Examples:
Get-info.ino, and Hello-world.ino.
uint16_t IQRFTR::getOsBuild ( )

Get OS build

Returns
Build of OS used inside of TR module
Examples:
Get-info.ino.
uint16_t IQRFTR::getOsVersion ( )

Get OS version

Returns
Version of OS used inside of TR module
Examples:
Get-info.ino.
bool IQRFTR::getProgramFlag ( )

Get programming flag

Returns
Programming flag
uint8_t IQRFTR::getRawInfoData ( uint8_t  position)

Get raw info data about TR module

Parameters
positionPosition in info raw buffer
Returns
Data byte from info raw buffer
void IQRFTR::reset ( )

Reset TR module

void IQRFTR::setControlStatus ( uint8_t  status)

Set TR control status

Parameters
statusTR control status
void IQRFTR::setInfoReadingStatus ( uint8_t  status)

Set TR info reading status

Parameters
statusTR info reading status
void IQRFTR::turnOff ( )

Enter TR module into OFF state

void IQRFTR::turnOn ( )

Enter TR module into ON state


The documentation for this class was generated from the following files: