Enums and Masks
Based on the approach I used in my RFM9X library this refactor adds enumerations and constants for initialising and then accessing the registers of the RFM69CW/RFM69HCW module (based on the Semtech SX1231/SX1231H) .
There is now a even less code in the Run method in the startup.cs file and the code for configuring the RFM69 is more obvious
public sealed class StartupTask : IBackgroundTask
{
private const int ResetPin = 25;
private const int InterruptPin = 22;
private Rfm69HcwDevice rfm69Device = new Rfm69HcwDevice(ChipSelectPin.CS1, ResetPin, InterruptPin);
public void Run(IBackgroundTaskInstance taskInstance)
{
byte[] syncValues ={0xAA, 0x2D, 0xD4};
rfm69Device.Initialise(Rfm69HcwDevice.RegOpModeMode.StandBy,
bitRate: Rfm69HcwDevice.BitRate.bps4K8,
frequency: 915000000.0, frequencyDeviation: 0X023d,
dccFrequency: 0x1,rxBwMant: Rfm69HcwDevice.RxBwMant.RxBwMant20, RxBwExp:0x2,
preambleSize: 16,
syncSize: 3,
syncValues: syncValues,
packetFormat: Rfm69HcwDevice.RegPacketConfig1PacketFormat.VariableLength,
packetCrc:true
);
// RegDioMapping1
rfm69Device.RegisterManager.WriteByte(0x26, 0x01);
rfm69Device.RegisterDump();
while (true)
{
byte[] messageBuffer = UTF8Encoding.UTF8.GetBytes("hello world " + DateTime.Now.ToLongTimeString());
rfm69Device.SendMessage(messageBuffer);
Debug.WriteLine("{0:HH:mm:ss.fff} Send-Done", DateTime.Now);
Task.Delay(5000).Wait();
}
}
The Rasmitic library modifies a number of the default settings (e.g. RegRxBw register) so I had to reverse engineer the values. I also added SendMessage methods for both addressed and un-addressed messages.
Register dump Register 0x01 - Value 0X04 - Bits 00000100 Register 0x02 - Value 0X00 - Bits 00000000 Register 0x03 - Value 0X1a - Bits 00011010 … Register 0x4b - Value 0X00 - Bits 00000000 Register 0x4c - Value 0X00 - Bits 00000000 Register 0x4d - Value 0X00 - Bits 00000000 16:52:38.337 Send-Done 16:52:38.456 RegIrqFlags 00001000 16:52:38.472 Transmit-Done The thread 0xfe4 has exited with code 0 (0x0). The thread 0x100 has exited with code 0 (0x0). 16:52:43.391 Send-Done 16:52:43.465 RegIrqFlags 00001000 16:52:43.480 Transmit-Done The thread 0xb94 has exited with code 0 (0x0). 16:52:48.475 Send-Done 16:52:48.550 RegIrqFlags 00001000 16:52:48.563 Transmit-Done 16:52:53.448 RegIrqFlags 01000110 16:52:53 Received 13 byte message Hello world:0 The thread 0x2b4 has exited with code 0 (0x0). 16:52:53.559 Send-Done 16:52:53.633 RegIrqFlags 00001000 16:52:53.648 Transmit-Done 16:52:54.577 RegIrqFlags 01000110 16:52:54 Received 13 byte message Hello world:1 16:52:55.706 RegIrqFlags 01000110 16:52:55 Received 13 byte message Hello world:2 16:52:56.836 RegIrqFlags 01000110 16:52:56 Received 13 byte message Hello world:3 16:52:57.965 RegIrqFlags 01000110 16:52:57 Received 13 byte message Hello world:4 The thread 0x354 has exited with code 0 (0x0). 16:52:58.634 Send-Done 16:52:58.709 RegIrqFlags 00001000 16:52:58.724 Transmit-Done 16:52:59.095 RegIrqFlags 01000110 16:52:59 Received 13 byte message Hello world:5 The program '[3736] backgroundTaskHost.exe' has exited with code -1
The Arduino code works though I need modify it so I can do more testing of the initialise method parameter options.
16:41:03.619 -> RX start 16:41:03.619 -> 0x0: 0x0 16:41:03.654 -> 0x1: 0x10 16:41:03.654 -> 0x2: 0x0 … 16:41:04.310 -> 0x3B: 0x0 16:41:04.310 -> 0x3C: 0x1 16:41:04.344 -> 0x3D: 0x0 16:41:07.228 -> MessageIn:hello world 4:41:07 PM 16:41:12.322 -> MessageIn:hello world 4:41:12 PM 16:41:17.395 -> MessageIn:hello world 4:41:17 PM 16:41:22.448 -> MessageIn:hello world 4:41:22 PM 16:41:27.533 -> MessageIn:hello world 4:41:27 PM 16:41:32.609 -> MessageIn:hello world 4:41:32 PM 16:41:37.673 -> MessageIn:hello world 4:41:37 PM
The Initialise method has a large number of parameters but as most of these have a reasonable default I’m not to concerned.
public void Initialise(RegOpModeMode modeAfterInitialise,
BitRate bitRate = BitRateDefault,
ushort frequencyDeviation = frequencyDeviationDefault,
double frequency = FrequencyDefault,
ListenModeIdleResolution listenModeIdleResolution = ListenModeIdleResolutionDefault, ListenModeRXTime listenModeRXTime = ListenModeRXTimeDefault, ListenModeCrieria listenModeCrieria = ListenModeCrieriaDefault, ListenModeEnd listenModeEnd = ListenModeEndDefault,
byte listenCoefficientIdle = ListenCoefficientIdleDefault,
byte listenCoefficientReceive = ListenCoefficientReceiveDefault,
bool pa0On = pa0OnDefault, bool pa1On = pa1OnDefaut, bool pa2On = pa2OnDefault, byte outputpower = OutputpowerDefault,
PaRamp paRamp = PaRampDefault,
bool ocpOn = OcpOnDefault, byte ocpTrim = OcpTrimDefault,
LnaZin lnaZin = LnaZinDefault, LnaCurrentGain lnaCurrentGain = LnaCurrentGainDefault, LnaGainSelect lnaGainSelect = LnaGainSelectDefault,
byte dccFrequency = DccFrequencyDefault, RxBwMant rxBwMant = RxBwMantDefault, byte RxBwExp = RxBwExpDefault,
byte dccFreqAfc = DccFreqAfcDefault, byte rxBwMantAfc = RxBwMantAfcDefault, byte bxBwExpAfc = RxBwExpAfcDefault,
ushort preambleSize = PreambleSizeDefault,
bool syncOn = SyncOnDefault, SyncFifoFileCondition syncFifoFileCondition = SyncFifoFileConditionDefault, byte syncSize = SyncSizeDefault, byte syncTolerance = SyncToleranceDefault, byte[] syncValues = null,
RegPacketConfig1PacketFormat packetFormat = RegPacketConfig1PacketFormat.FixedLength,
RegPacketConfig1DcFree packetDcFree = RegPacketConfig1DcFreeDefault,
bool packetCrc = PacketCrcOnDefault,
bool packetCrcAutoClearOff = PacketCrcAutoClearOffDefault,
RegPacketConfig1CrcAddressFiltering packetAddressFiltering = PacketAddressFilteringDefault,
byte payloadLength = PayloadLengthDefault,
byte addressNode = NodeAddressDefault, byte addressbroadcast = BroadcastAddressDefault
)
{
RegOpModeModeCurrent = modeAfterInitialise;
PacketFormat = packetFormat;
// Strobe Reset pin briefly to factory reset SX1231 chip
ResetGpioPin.Write(GpioPinValue.High);
Task.Delay(100);
ResetGpioPin.Write(GpioPinValue.Low);
Task.Delay(10);
// Put the device into sleep mode so registers can be changed
SetMode(RegOpModeMode.Sleep);
Most of the initialise method follows a similar pattern, checking parameters associated with a Register and only setting it if the cvalues are not all the default
// Configure RF Carrier frequency RegFrMsb, RegFrMid, RegFrLsb
if (frequency != FrequencyDefault)
{
byte[] bytes = BitConverter.GetBytes((long)(frequency / RH_RFM69HCW_FSTEP));
RegisterManager.WriteByte((byte)Registers.RegFrfMsb, bytes[2]);
RegisterManager.WriteByte((byte)Registers.RegFrfMid, bytes[1]);
RegisterManager.WriteByte((byte)Registers.RegFrfLsb, bytes[0]);
}
Some registers are a bit more complex to configure e.g. RegSyncConfig
// RegSyncConfig
if ((syncOn != SyncOnDefault) ||
(syncFifoFileCondition != SyncFifoFileConditionDefault) ||
(syncSize != SyncSizeDefault) ||
(syncTolerance != SyncToleranceDefault))
{
byte regSyncConfigValue= 0b00000000;
if (syncOn)
{
regSyncConfigValue |= 0b10000000;
}
regSyncConfigValue |= (byte)syncFifoFileCondition;
regSyncConfigValue |= (byte)((syncSize - 1) << 3);
regSyncConfigValue |= (byte)syncTolerance;
RegisterManager.WriteByte((byte)Registers.RegSyncConfig, regSyncConfigValue);
}
I have just got to finish the code for RegFifoThresh, RegPacketConfig2 and the RegAesKey1-16 registers.
Other libraries for the RRFM69 support changing configuration while the application is running which significantly increases the complexity and number of test cases. My initial version will only support configuration on start-up.
