lbandrtk 2.1.0.0
LBAND RTK Registers Settings

Settings for registers of LBAND RTK Click driver. More...

Macros

#define LBANDRTK_CLASS_ID_UBX_ACK   0x05
 LBAND RTK UBX class and message IDs.
 
#define LBANDRTK_CLASS_ID_UBX_CFG   0x06
 
#define LBANDRTK_CLASS_ID_UBX_INF   0x04
 
#define LBANDRTK_CLASS_ID_UBX_MON   0x0A
 
#define LBANDRTK_CLASS_ID_UBX_RXM   0x02
 
#define LBANDRTK_MSG_ID_UBX_ACK_ACK   0x01
 
#define LBANDRTK_MSG_ID_UBX_ACK_NAK   0x00
 
#define LBANDRTK_MSG_ID_UBX_CFG_RST   0x04
 
#define LBANDRTK_MSG_ID_UBX_CFG_VALDEL   0x8C
 
#define LBANDRTK_MSG_ID_UBX_CFG_VALGET   0x8B
 
#define LBANDRTK_MSG_ID_UBX_CFG_VALSET   0x8A
 
#define LBANDRTK_MSG_ID_UBX_INF_ERROR   0x00
 
#define LBANDRTK_MSG_ID_UBX_INF_NOTICE   0x02
 
#define LBANDRTK_MSG_ID_UBX_INF_WARNING   0x01
 
#define LBANDRTK_MSG_ID_UBX_MON_HW2   0x0B
 
#define LBANDRTK_MSG_ID_UBX_MON_VER   0x04
 
#define LBANDRTK_MSG_ID_UBX_RXM_PMP   0x72
 
#define LBANDRTK_MSG_ID_UBX_RXM_PMREQ   0x41
 
#define LBANDRTK_VER_CFG_POLL_REQUEST   0x00
 LBAND RTK UBX configuration items setting.
 
#define LBANDRTK_VER_CFG_POLLED   0x01
 
#define LBANDRTK_LAYER_RAM   0x01
 
#define LBANDRTK_LAYER_BBR   0x02
 
#define LBANDRTK_LAYER_FLASH   0x04
 
#define LBANDRTK_LAYER_ALL   0x07
 
#define LBANDRTK_KEY_ID_SIZE_1_BIT   0x10000000ul
 
#define LBANDRTK_KEY_ID_SIZE_1_BYTE   0x20000000ul
 
#define LBANDRTK_KEY_ID_SIZE_2_BYTES   0x30000000ul
 
#define LBANDRTK_KEY_ID_SIZE_4_BYTES   0x40000000ul
 
#define LBANDRTK_KEY_ID_SIZE_8_BYTES   0x50000000ul
 
#define LBANDRTK_KEY_ID_SIZE_MASK   0x70000000ul
 
#define LBANDRTK_KEY_ID_GROUP_MASK   0x00FF0000ul
 
#define LBANDRTK_KEY_ID_ITEM_MASK   0x00000FFFul
 
#define LBANDRTK_CFG_PMP_CENTER_FREQUENCY   0x40B10011ul
 
#define LBANDRTK_CFG_PMP_SEARCH_WINDOW   0x30B10012ul
 
#define LBANDRTK_CFG_PMP_USE_SERVICE_ID   0x10B10016ul
 
#define LBANDRTK_CFG_PMP_SERVICE_ID   0x30B10017ul
 
#define LBANDRTK_CFG_PMP_DATA_RATE   0x30B10013ul
 
#define LBANDRTK_CFG_PMP_USE_DESCRAMBLER   0x10B10014ul
 
#define LBANDRTK_CFG_PMP_DESCRAMBLER_INIT   0x30B10015ul
 
#define LBANDRTK_CFG_PMP_USE_PRESCRAMBLING   0x10B10019ul
 
#define LBANDRTK_CFG_PMP_UNIQUE_WORD   0x50B1001Aul
 
#define LBANDRTK_PREAMBLE_SYNC_CHAR_1   0xB5
 LBAND RTK UBX header bytes.
 
#define LBANDRTK_PREAMBLE_SYNC_CHAR_2   0x62
 
#define LBANDRTK_MAX_PAYLOAD_LEN   528u
 LBAND RTK UBX max payload size.
 
#define LBANDRTK_DUMMY   0xFF
 LBAND RTK dummy data.
 
#define LBANDRTK_TIMEOUT   3000u
 LBAND RTK response timeout and retries values.
 
#define LBANDRTK_NUM_OF_RETRIES   5
 
#define LBANDRTK_PMP_CENTER_FREQ_EU   1545260000ul
 LBAND RTK CFG-PMP: Point to multipoint (PMP) default configuration.
 
#define LBANDRTK_PMP_CENTER_FREQ_US   1556290000ul
 
#define LBANDRTK_PMP_CENTER_FREQ   LBANDRTK_PMP_CENTER_FREQ_EU
 
#define LBANDRTK_PMP_SEARCH_WINDOW   2200u
 
#define LBANDRTK_PMP_USE_SERVICE_ID   0
 
#define LBANDRTK_PMP_SERVICE_ID   21845u
 
#define LBANDRTK_PMP_DATA_RATE   2400u
 
#define LBANDRTK_PMP_USE_DESCRAMBLER   1
 
#define LBANDRTK_PMP_DESCRAMBLER_INIT   26969u
 
#define LBANDRTK_PMP_USE_PRESCRAMBLING   0
 
#define LBANDRTK_PMP_UNIQUE_WORD_HIGH   0xE15AE893ul
 
#define LBANDRTK_PMP_UNIQUE_WORD_LOW   0xE15AE893ul
 
#define LBANDRTK_UBX_RXM_PMP_MAX_USER_DATA   504u
 LBAND RTK UBX-RXM-PMP setting.
 
#define LBANDRTK_UBX_RXM_PMP_EBN0_SCALE   0.125f
 
#define LBANDRTK_SET_DEV_ADDR   0x43
 LBAND RTK device address setting.
 
#define LBANDRTK_DRV_TX_BUFFER_SIZE   ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )
 LBAND RTK driver buffer size.
 
#define LBANDRTK_DRV_RX_BUFFER_SIZE   ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )
 
#define LBANDRTK_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define LBANDRTK_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 

Detailed Description

Settings for registers of LBAND RTK Click driver.

Macro Definition Documentation

◆ LBANDRTK_CFG_PMP_CENTER_FREQUENCY

#define LBANDRTK_CFG_PMP_CENTER_FREQUENCY   0x40B10011ul

◆ LBANDRTK_CFG_PMP_DATA_RATE

#define LBANDRTK_CFG_PMP_DATA_RATE   0x30B10013ul

◆ LBANDRTK_CFG_PMP_DESCRAMBLER_INIT

#define LBANDRTK_CFG_PMP_DESCRAMBLER_INIT   0x30B10015ul

◆ LBANDRTK_CFG_PMP_SEARCH_WINDOW

#define LBANDRTK_CFG_PMP_SEARCH_WINDOW   0x30B10012ul

◆ LBANDRTK_CFG_PMP_SERVICE_ID

#define LBANDRTK_CFG_PMP_SERVICE_ID   0x30B10017ul

◆ LBANDRTK_CFG_PMP_UNIQUE_WORD

#define LBANDRTK_CFG_PMP_UNIQUE_WORD   0x50B1001Aul

◆ LBANDRTK_CFG_PMP_USE_DESCRAMBLER

#define LBANDRTK_CFG_PMP_USE_DESCRAMBLER   0x10B10014ul

◆ LBANDRTK_CFG_PMP_USE_PRESCRAMBLING

#define LBANDRTK_CFG_PMP_USE_PRESCRAMBLING   0x10B10019ul

◆ LBANDRTK_CFG_PMP_USE_SERVICE_ID

#define LBANDRTK_CFG_PMP_USE_SERVICE_ID   0x10B10016ul

◆ LBANDRTK_CLASS_ID_UBX_ACK

#define LBANDRTK_CLASS_ID_UBX_ACK   0x05

LBAND RTK UBX class and message IDs.

Specified UBX class and message IDs of LBAND RTK Click driver.

◆ LBANDRTK_CLASS_ID_UBX_CFG

#define LBANDRTK_CLASS_ID_UBX_CFG   0x06

◆ LBANDRTK_CLASS_ID_UBX_INF

#define LBANDRTK_CLASS_ID_UBX_INF   0x04

◆ LBANDRTK_CLASS_ID_UBX_MON

#define LBANDRTK_CLASS_ID_UBX_MON   0x0A

◆ LBANDRTK_CLASS_ID_UBX_RXM

#define LBANDRTK_CLASS_ID_UBX_RXM   0x02

◆ LBANDRTK_DRV_RX_BUFFER_SIZE

#define LBANDRTK_DRV_RX_BUFFER_SIZE   ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )

◆ LBANDRTK_DRV_TX_BUFFER_SIZE

#define LBANDRTK_DRV_TX_BUFFER_SIZE   ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )

LBAND RTK driver buffer size.

Specified size of driver ring buffer.

Note
Increase buffer size if needed.

◆ LBANDRTK_DUMMY

#define LBANDRTK_DUMMY   0xFF

LBAND RTK dummy data.

Definition of dummy data.

◆ LBANDRTK_KEY_ID_GROUP_MASK

#define LBANDRTK_KEY_ID_GROUP_MASK   0x00FF0000ul

◆ LBANDRTK_KEY_ID_ITEM_MASK

#define LBANDRTK_KEY_ID_ITEM_MASK   0x00000FFFul

◆ LBANDRTK_KEY_ID_SIZE_1_BIT

#define LBANDRTK_KEY_ID_SIZE_1_BIT   0x10000000ul

◆ LBANDRTK_KEY_ID_SIZE_1_BYTE

#define LBANDRTK_KEY_ID_SIZE_1_BYTE   0x20000000ul

◆ LBANDRTK_KEY_ID_SIZE_2_BYTES

#define LBANDRTK_KEY_ID_SIZE_2_BYTES   0x30000000ul

◆ LBANDRTK_KEY_ID_SIZE_4_BYTES

#define LBANDRTK_KEY_ID_SIZE_4_BYTES   0x40000000ul

◆ LBANDRTK_KEY_ID_SIZE_8_BYTES

#define LBANDRTK_KEY_ID_SIZE_8_BYTES   0x50000000ul

◆ LBANDRTK_KEY_ID_SIZE_MASK

#define LBANDRTK_KEY_ID_SIZE_MASK   0x70000000ul

◆ LBANDRTK_LAYER_ALL

#define LBANDRTK_LAYER_ALL   0x07

◆ LBANDRTK_LAYER_BBR

#define LBANDRTK_LAYER_BBR   0x02

◆ LBANDRTK_LAYER_FLASH

#define LBANDRTK_LAYER_FLASH   0x04

◆ LBANDRTK_LAYER_RAM

#define LBANDRTK_LAYER_RAM   0x01

◆ LBANDRTK_MAX_PAYLOAD_LEN

#define LBANDRTK_MAX_PAYLOAD_LEN   528u

LBAND RTK UBX max payload size.

Specified UBX max payload size of LBAND RTK Click driver.

◆ LBANDRTK_MSG_ID_UBX_ACK_ACK

#define LBANDRTK_MSG_ID_UBX_ACK_ACK   0x01

◆ LBANDRTK_MSG_ID_UBX_ACK_NAK

#define LBANDRTK_MSG_ID_UBX_ACK_NAK   0x00

◆ LBANDRTK_MSG_ID_UBX_CFG_RST

#define LBANDRTK_MSG_ID_UBX_CFG_RST   0x04

◆ LBANDRTK_MSG_ID_UBX_CFG_VALDEL

#define LBANDRTK_MSG_ID_UBX_CFG_VALDEL   0x8C

◆ LBANDRTK_MSG_ID_UBX_CFG_VALGET

#define LBANDRTK_MSG_ID_UBX_CFG_VALGET   0x8B

◆ LBANDRTK_MSG_ID_UBX_CFG_VALSET

#define LBANDRTK_MSG_ID_UBX_CFG_VALSET   0x8A

◆ LBANDRTK_MSG_ID_UBX_INF_ERROR

#define LBANDRTK_MSG_ID_UBX_INF_ERROR   0x00

◆ LBANDRTK_MSG_ID_UBX_INF_NOTICE

#define LBANDRTK_MSG_ID_UBX_INF_NOTICE   0x02

◆ LBANDRTK_MSG_ID_UBX_INF_WARNING

#define LBANDRTK_MSG_ID_UBX_INF_WARNING   0x01

◆ LBANDRTK_MSG_ID_UBX_MON_HW2

#define LBANDRTK_MSG_ID_UBX_MON_HW2   0x0B

◆ LBANDRTK_MSG_ID_UBX_MON_VER

#define LBANDRTK_MSG_ID_UBX_MON_VER   0x04

◆ LBANDRTK_MSG_ID_UBX_RXM_PMP

#define LBANDRTK_MSG_ID_UBX_RXM_PMP   0x72

◆ LBANDRTK_MSG_ID_UBX_RXM_PMREQ

#define LBANDRTK_MSG_ID_UBX_RXM_PMREQ   0x41

◆ LBANDRTK_NUM_OF_RETRIES

#define LBANDRTK_NUM_OF_RETRIES   5

◆ LBANDRTK_PMP_CENTER_FREQ

#define LBANDRTK_PMP_CENTER_FREQ   LBANDRTK_PMP_CENTER_FREQ_EU

◆ LBANDRTK_PMP_CENTER_FREQ_EU

#define LBANDRTK_PMP_CENTER_FREQ_EU   1545260000ul

LBAND RTK CFG-PMP: Point to multipoint (PMP) default configuration.

Specified CFG-PMP: Point to multipoint (PMP) default configuration of LBAND RTK Click driver.

◆ LBANDRTK_PMP_CENTER_FREQ_US

#define LBANDRTK_PMP_CENTER_FREQ_US   1556290000ul

◆ LBANDRTK_PMP_DATA_RATE

#define LBANDRTK_PMP_DATA_RATE   2400u

◆ LBANDRTK_PMP_DESCRAMBLER_INIT

#define LBANDRTK_PMP_DESCRAMBLER_INIT   26969u

◆ LBANDRTK_PMP_SEARCH_WINDOW

#define LBANDRTK_PMP_SEARCH_WINDOW   2200u

◆ LBANDRTK_PMP_SERVICE_ID

#define LBANDRTK_PMP_SERVICE_ID   21845u

◆ LBANDRTK_PMP_UNIQUE_WORD_HIGH

#define LBANDRTK_PMP_UNIQUE_WORD_HIGH   0xE15AE893ul

◆ LBANDRTK_PMP_UNIQUE_WORD_LOW

#define LBANDRTK_PMP_UNIQUE_WORD_LOW   0xE15AE893ul

◆ LBANDRTK_PMP_USE_DESCRAMBLER

#define LBANDRTK_PMP_USE_DESCRAMBLER   1

◆ LBANDRTK_PMP_USE_PRESCRAMBLING

#define LBANDRTK_PMP_USE_PRESCRAMBLING   0

◆ LBANDRTK_PMP_USE_SERVICE_ID

#define LBANDRTK_PMP_USE_SERVICE_ID   0

◆ LBANDRTK_PREAMBLE_SYNC_CHAR_1

#define LBANDRTK_PREAMBLE_SYNC_CHAR_1   0xB5

LBAND RTK UBX header bytes.

Specified UBX header byte of LBAND RTK Click driver.

◆ LBANDRTK_PREAMBLE_SYNC_CHAR_2

#define LBANDRTK_PREAMBLE_SYNC_CHAR_2   0x62

◆ LBANDRTK_SET_DATA_SAMPLE_EDGE

#define LBANDRTK_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE

Data sample selection.

This macro sets data samples for SPI modules.

Note
Available only on Microchip PIC family devices. This macro will set data sampling for all SPI modules on MCU. Can be overwritten with lbandrtk_init which will set SET_SPI_DATA_SAMPLE_MIDDLE by default on the mapped mikrobus.

◆ LBANDRTK_SET_DATA_SAMPLE_MIDDLE

#define LBANDRTK_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE

◆ LBANDRTK_SET_DEV_ADDR

#define LBANDRTK_SET_DEV_ADDR   0x43

LBAND RTK device address setting.

Specified setting for device slave address selection of LBAND RTK Click driver.

◆ LBANDRTK_TIMEOUT

#define LBANDRTK_TIMEOUT   3000u

LBAND RTK response timeout and retries values.

Specified response timeout value in milliseconds and number of retries of LBAND RTK Click driver.

◆ LBANDRTK_UBX_RXM_PMP_EBN0_SCALE

#define LBANDRTK_UBX_RXM_PMP_EBN0_SCALE   0.125f

◆ LBANDRTK_UBX_RXM_PMP_MAX_USER_DATA

#define LBANDRTK_UBX_RXM_PMP_MAX_USER_DATA   504u

LBAND RTK UBX-RXM-PMP setting.

Specified UBX-RXM-PMP setting of LBAND RTK Click driver.

◆ LBANDRTK_VER_CFG_POLL_REQUEST

#define LBANDRTK_VER_CFG_POLL_REQUEST   0x00

LBAND RTK UBX configuration items setting.

Specified UBX configuration items setting of LBAND RTK Click driver.

◆ LBANDRTK_VER_CFG_POLLED

#define LBANDRTK_VER_CFG_POLLED   0x01