C# Класс HouseOfTheFuture.RF24Library.NRF24L01Plus

Показать файл Открыть проект

Открытые методы

Метод Описание
Configure ( byte address, byte channel ) : void

Configure the module basic settings. Module needs to be initiaized.

Configure ( byte address, byte channel, NRFDataRate dataRate ) : void

Configure the module basic settings. Module needs to be initiaized.

Disable ( ) : void

Disables the module

Enable ( ) : void

Enables the module

Execute ( byte command, byte addres, byte data ) : byte[]

Executes a command in NRF24L01+ (for details see module datasheet)

GetAddress ( AddressSlot slot, int width ) : byte[]

Read 1 of 6 available module addresses

GetChannel ( ) : byte

Reads the current rf channel value set in module

GetFrequency ( ) : int

Gets the module radio frequency [MHz]

GetStatus ( ) : Status

Gets module basic status information

HandleInterrupt ( uint data1, uint data2, System.DateTime dateTime ) : void
Initialize ( SpiMode spiMode, int chipSelectPin, int chipEnablePin, int interruptPin ) : void

Initializes SPI connection and control pins

NRF24L01Plus ( ) : System
SendTo ( byte address, byte bytes, int timeout ) : bool

Sends bytes to given address This is a blocking method that returns true if data was received by the recipient or false if timeout occured.

SendTo ( byte address, byte bytes, Acknowledge acknowledge = Acknowledge.Yes ) : void

Send bytes to given address This is a non blocking method.

SetAddress ( AddressSlot slot, byte address ) : void

Set one of 6 available module addresses

SetChannel ( byte channel ) : void

Sets the rf channel value used by all data pipes

Приватные методы

Метод Описание
CheckIsInitialized ( ) : void
InitSpi ( int chipSelectPin, SpiMode mode ) : Task
SetDisabled ( ) : void
SetEnabled ( ) : void
SetReceiveMode ( ) : void
SetTransmitMode ( ) : void
_irqPin_ValueChanged ( Windows.Devices.Gpio.GpioPin sender, Windows.Devices.Gpio.GpioPinValueChangedEventArgs args ) : void

Описание методов

Configure() публичный Метод

Configure the module basic settings. Module needs to be initiaized.
public Configure ( byte address, byte channel ) : void
address byte RF address (3-5 bytes). The width of this address determins the width of all addresses used for sending/receiving.
channel byte RF channel (0-127)
Результат void

Configure() публичный Метод

Configure the module basic settings. Module needs to be initiaized.
public Configure ( byte address, byte channel, NRFDataRate dataRate ) : void
address byte RF address (3-5 bytes). The width of this address determins the width of all addresses used for sending/receiving.
channel byte RF channel (0-127)
dataRate NRFDataRate Data Rate to use
Результат void

Disable() публичный Метод

Disables the module
public Disable ( ) : void
Результат void

Enable() публичный Метод

Enables the module
public Enable ( ) : void
Результат void

Execute() публичный Метод

Executes a command in NRF24L01+ (for details see module datasheet)
public Execute ( byte command, byte addres, byte data ) : byte[]
command byte Command
addres byte Register to write to
data byte Data to write
Результат byte[]

GetAddress() публичный Метод

Read 1 of 6 available module addresses
public GetAddress ( AddressSlot slot, int width ) : byte[]
slot AddressSlot
width int
Результат byte[]

GetChannel() публичный Метод

Reads the current rf channel value set in module
public GetChannel ( ) : byte
Результат byte

GetFrequency() публичный Метод

Gets the module radio frequency [MHz]
public GetFrequency ( ) : int
Результат int

GetStatus() публичный Метод

Gets module basic status information
public GetStatus ( ) : Status
Результат Status

HandleInterrupt() публичный Метод

public HandleInterrupt ( uint data1, uint data2, System.DateTime dateTime ) : void
data1 uint
data2 uint
dateTime System.DateTime
Результат void

Initialize() публичный Метод

Initializes SPI connection and control pins
public Initialize ( SpiMode spiMode, int chipSelectPin, int chipEnablePin, int interruptPin ) : void
spiMode SpiMode
chipSelectPin int
chipEnablePin int
interruptPin int
Результат void

NRF24L01Plus() публичный Метод

public NRF24L01Plus ( ) : System
Результат System

SendTo() публичный Метод

Sends bytes to given address This is a blocking method that returns true if data was received by the recipient or false if timeout occured.
public SendTo ( byte address, byte bytes, int timeout ) : bool
address byte
bytes byte
timeout int
Результат bool

SendTo() публичный Метод

Send bytes to given address This is a non blocking method.
public SendTo ( byte address, byte bytes, Acknowledge acknowledge = Acknowledge.Yes ) : void
address byte
bytes byte
acknowledge Acknowledge
Результат void

SetAddress() публичный Метод

Set one of 6 available module addresses
public SetAddress ( AddressSlot slot, byte address ) : void
slot AddressSlot
address byte
Результат void

SetChannel() публичный Метод

Sets the rf channel value used by all data pipes
public SetChannel ( byte channel ) : void
channel byte 7 bit channel value
Результат void