RUI3 (RAK Unified Interface 3) - RAK4631
RAKLorawan

Data Structures

class  adr
 
class  appeui
 
class  appkey
 
class  appskey
 
class  band
 
class  bfreq
 
class  bgw
 
class  btime
 
class  cfm
 
class  cfs
 
class  daddr
 
class  dcs
 
class  deui
 
class  deviceClass
 
class  dr
 
class  enciv
 
class  enckey
 
class  encry
 
class  jn1dl
 
class  jn2dl
 
class  linkcheck
 
class  ltime
 
class  mask
 
class  netid
 
class  njm
 
class  njs
 
class  nwkskey
 
class  nwm
 
class  pbr
 
class  pbw
 
class  pcr
 
class  pfdev
 
class  pfreq
 
class  pgslot
 
class  pnm
 
class  ppl
 
class  psf
 
class  ptp
 
class  rety
 
class  rssi
 
class  rx1dl
 
class  rx2dl
 
class  rx2dr
 
class  rx2fq
 
class  snr
 
class  txp
 
class  ver
 

Public Member Functions

 RAKLorawan ()
 
bool join ()
 
bool join (uint8_t join_start, uint8_t auto_join, uint8_t auto_join_period, uint8_t auto_join_cnt)
 
bool send (uint8_t length, uint8_t *payload, uint8_t fport, bool confirm, uint8_t retry)
 
bool send (uint8_t length, uint8_t *payload, uint8_t fport, bool confirm)
 
bool send (uint8_t length, uint8_t *payload, uint8_t fport)
 
bool lpsend (uint8_t port, bool ack, uint8_t *payload, int length)
 
bool usend (uint8_t port, bool confirm, uint8_t retry, uint8_t *payload, uint8_t length)
 
bool registerRecvCallback (service_lora_recv_cb callback)
 
bool registerJoinCallback (service_lora_join_cb callback)
 
bool registerSendCallback (service_lora_send_cb callback)
 
bool registerPRecvCallback (service_lora_p2p_recv_cb_type callback)
 
bool registerPSendCallback (service_lora_p2p_send_cb_type callback)
 
bool registerPSendCADCallback (service_lora_p2p_send_CAD_cb_type callback)
 
bool precv (uint32_t timeout)
 
bool psend (uint8_t length, uint8_t *payload)
 
bool psend (uint8_t length, uint8_t *payload, bool cad_enable)
 
bool addmulc (RAK_LORA_McSession session)
 
bool rmvmulc (uint32_t devAddr)
 
bool lstmulc (RAK_LORA_McSession *iterator)
 
bool arssi (RAK_LORA_chan_rssi *iterator)
 

Data Fields

rety rety
 
appeui appeui
 
appkey appkey
 
appskey appskey
 
daddr daddr
 
deui deui
 
netid netid
 
nwkskey nwkskey
 
cfm cfm
 
cfs cfs
 
njm njm
 
njs njs
 
adr adr
 
deviceClass deviceClass
 
dcs dcs
 
dr dr
 
jn1dl jn1dl
 
jn2dl jn2dl
 
pnm pnm
 
rx1dl rx1dl
 
rx2dl rx2dl
 
rx2dr rx2dr
 
rx2fq rx2fq
 
txp txp
 
pgslot pgslot
 
bfreq bfreq
 
btime btime
 
bgw bgw
 
rssi rssi
 
snr snr
 
ltime ltime
 
ver ver
 
mask mask
 
band band
 
linkcheck linkcheck
 
nwm nwm
 
pfreq pfreq
 
psf psf
 
pbw pbw
 
pcr pcr
 
ppl ppl
 
ptp ptp
 
encry encry
 
enckey enckey
 
enciv enciv
 
pbr pbr
 
pfdev pfdev
 

Constructor & Destructor Documentation

◆ RAKLorawan()

Member Function Documentation

◆ join()

bool join ( uint8_t  join_start,
uint8_t  auto_join,
uint8_t  auto_join_period,
uint8_t  auto_join_cnt 
)

◆ send() [1/2]

bool send ( uint8_t  length,
uint8_t *  payload,
uint8_t  fport,
bool  confirm 
)

◆ send() [2/2]

bool send ( uint8_t  length,
uint8_t *  payload,
uint8_t  fport 
)

◆ usend()

bool usend ( uint8_t  port,
bool  confirm,
uint8_t  retry,
uint8_t *  payload,
uint8_t  length 
)
Description
Syntax
api.lorawan.usend(port, confirm, retry, payload, length)
Parameters
port
confirm
retry
payload
length
Returns

◆ psend()

bool psend ( uint8_t  length,
uint8_t *  payload,
bool  cad_enable 
)

Field Documentation

◆ rety

◆ appeui

◆ appkey

◆ appskey

◆ daddr

◆ deui

◆ netid

◆ nwkskey

◆ cfm

◆ cfs

◆ njm

◆ njs

◆ adr

◆ deviceClass

◆ dcs

◆ dr

dr dr

◆ jn1dl

◆ jn2dl

◆ pnm

◆ rx1dl

◆ rx2dl

◆ rx2dr

◆ rx2fq

◆ txp

◆ pgslot

◆ bfreq

◆ btime

◆ bgw

◆ rssi

◆ snr

◆ ltime

◆ ver

◆ mask

◆ band

◆ linkcheck

◆ nwm

◆ pfreq

◆ psf

◆ pbw

◆ pcr

◆ ppl

◆ ptp

◆ encry

◆ enckey

◆ enciv

◆ pbr

◆ pfdev