poslib_ble_beacon.h File Reference

Header for the BLE beacons module. More...

Detailed Description

Header for the BLE beacons module.

Copyright

Wirepas Ltd 2021

Definition in file poslib_ble_beacon.h.

Go to the source code of this file.

Functions
poslib_ret_e	PosLibBle_start (ble_beacon_settings_t *settings)
	Starts the BLE module and sets the beacons according to the provided configuration Note that if requeste mode is POSLIB_BLE_ON_WHEN_OFFLINE the beacons will only be started when the node is outside the WM coverage. More...
void	PosLibBle_stop ()
	Stops BLE beacons, the module can only be restarted by calling PosLibBle_start More...
void	PosLibBle_processEvent (poslib_internal_event_t *event)
	BLE module event processing function More...
bool	PosLibBle_getEddystoneStatus ()
	Get the status of BLE Eddystone beacon. More...
bool	PosLibBle_getiBeaconStatus ()
	Get the status of BLE iBeacon beacon. More...

Function Documentation

PosLibBle_getEddystoneStatus()

bool PosLibBle_getEddystoneStatus

(

)

Get the status of BLE Eddystone beacon.

Returns

true/false : started/stoped

PosLibBle_getiBeaconStatus()

bool PosLibBle_getiBeaconStatus

(

)

Get the status of BLE iBeacon beacon.

Returns

true/false : started/stoped

PosLibBle_processEvent()

void PosLibBle_processEvent

(

poslib_internal_event_t *

event

)

BLE module event processing function

Parameters

event

the event to process ( pointer to poslib_internal_event_t )

Returns

void

PosLibBle_start()

poslib_ret_e PosLibBle_start

(

ble_beacon_settings_t *

settings

)

Starts the BLE module and sets the beacons according to the provided configuration Note that if requeste mode is POSLIB_BLE_ON_WHEN_OFFLINE the beacons will only be started when the node is outside the WM coverage.

Parameters

settings

Pointer to ble_beacon_settings_t structure

Returns

poslib_ret_e POS_RET_OK: start successful

PosLibBle_stop()

void PosLibBle_stop

(

)

Stops BLE beacons, the module can only be restarted by calling PosLibBle_start

Parameters

void

Returns

void