pyupm_nrf24l01 module

class pyupm_nrf24l01.Callback

Bases: object

run()

virtual void run(clbk_data arg)

class pyupm_nrf24l01.NRF24L01(cs, ce)

Bases: object

API for the NRF24L01 Transceiver Module.

ID: nrf24l01

Name: NRF Transceiver

Category: wifi

Manufacturer: seeed sparkfun

Link:http://www.seeedstudio.com/depot/nRF24L01Module-p-1394.html

Connection: spi id This module defines the NRF24L01 interface for libnrf24l01

C++ includes: nrf24l01.hpp

ceHigh()

mraa::Result ceHigh()

Sets the chip enable pin to HIGH

ceLow()

mraa::Result ceLow()

Sets the chip enable pin to LOW

configure()

void configure()

Configures the NRF24L01 transceiver

csOff()

mraa::Result csOff()

Sets the chip select pin to HIGH

csOn()

mraa::Result csOn()

Sets the chip select pin to LOW

dataReady()

bool dataReady()

Checks if the data has arrived

dataSending()

bool dataSending()

Checks if the transceiver is in the sending mode

getData(data)

void getData(uint8_t *data)

Sinks all the arrived data into a provided buffer

data: Pointer to the buffer

getStatus()

uint8_t getStatus()

Checks the transceiver state

init(chipSelect, chipEnable)

void init(int chipSelect, int chipEnable)

Initializes needed GPIO pins and SPI

chipSelect: Sets up the chip select pin

chipEnable: Sets up the chip enable pin

m_bleBuffer

m_rxBuffer

m_txBuffer

name()

std::string name()

Returns the name of the component

pollListener()

void pollListener()

Pulling the method listening for the arrived data, dataRecievedHandler is triggered if data arrives

powerDown()

void powerDown()

Powers everything down

rxFifoEmpty()

bool rxFifoEmpty()

Checks if the receive stack is empty

rxFlushBuffer()

void rxFlushBuffer()

Flushes the receive stack

rxPowerUp()

void rxPowerUp()

Powers the receiver up

send(*args)

void send()

Sends the data located in an inner bufer; the user must fill the m_txBuffer buffer

sendBeaconingMsg(msg)

void sendBeaconingMsg(uint8_t *msg)

Beacons the provided message to BLE scanners.

msg: Beacons the provided message (max length is 16 bytes)

setBeaconingMode()

void setBeaconingMode()

Configures the NRF24L01 transceiver to behave as a BLE (Bluetooth Low Energy) beaconing devcie.

setBroadcastAddress(addr)

void setBroadcastAddress(uint8_t *addr)

Sets a broadcasting address

addr: 5-byte address

setChannel(channel)

void setChannel(uint8_t channel)

setDataReceivedHandler(call_obj)

void setDataReceivedHandler(Callback *call_obj)

Sets the handler to be called when data has been received

call_obj: Object used for callback - Java

setDestinationAddress(addr)

void setDestinationAddress(uint8_t *addr)

Sets a recipient address. The nrfSend method sends the data buffer to this address

addr: 5-byte address

setPayload(load)

void setPayload(uint8_t load)

Sets the payload size

load: Size of the payload (MAX 32)

setPower(power)

void setPower(power_t power)

setSourceAddress(addr)

void setSourceAddress(uint8_t *addr)

Sets a receiving address of the device

addr: 5-byte address

setSpeedRate(rate)

uint8_t setSpeedRate(speed_rate_t rate)

txFlushBuffer()

void txFlushBuffer()

Flushes the transmit stack

txPowerUp()

void txPowerUp()

Powers the transmitter up

pyupm_nrf24l01.generic_callback(callback)

void generic_callback(Callback *callback)

class pyupm_nrf24l01.uint8Array(nelements)

Bases: object

cast()

static frompointer()