The Arduino library for the TI CC1101 sub-1 Ghz RF transceiver.
CC1101 key features:
- Modulations: ASK (OOK), 2-FSK, GFSK, 4-FSK, MSK
- Frequency bands: 300-348 MHz, 387-464 MHz, 779-928 MHz
- Data rate: 0.6 to 600 kbps
- Output power up to +12 dBm
- Support for sync word detection, address check, flexible packet length, and automatic CRC handling
For more information check out the datasheet.
The CC1101 module uses the SPI interface for communication. The SI, SO, SCLK pins should be connected to dedicated SPI pins on your Arduino board. The CSn can be connected to any digital pin.
The CC1101 exposes also two general purpose pins (GDO0, GDO2) which can be used to interrupt the MCU on certain events (e.g. RX FIFO is filled). They are optional and not required for proper work.
void setModulation(Modulation mod)Sets the modulation. Allowed modulations: MOD_2FSK, MOD_GFSK, MOD_ASK_OOK, MOD_4FSK, MOD_MSK.
Status setFrequency(double freq)Sets the frequency (in MHz). Allowed frequency bands: 300-348 MHz, 387-464 MHz, 779-928 MHz.
Returns STATUS_INVALID_PARAM on bad frequency.
Status setFrequencyDeviation(double dev)Sets the frequency deviation. Allowed frequency deviation range: 1.587 to 380.859 kHz (assuming 26.0 MHz crystal frequency). For MOD_ASK_OOK modulation this setting has no effect.
Returns STATUS_INVALID_PARAM on bad frequency deviation.
void setChannel(uint8_t ch)Sets the channel frequency. The channel frequency is multiplied by the channel spacing setting and added to the base frequency.
Status setChannelSpacing(double sp)Sets the channel spacing frequency (in kHz). Allowed channel spacing range: 25.390 to 405.456 kHz (assuming 26.0 MHz crystal frequency).
Returns STATUS_INVALID_PARAM on bad channel spacing.
Status setDataRate(double drate)Sets the data rate (in kBaud). The allowed data rate depends on the selected modulation (see General Characteristics Table in the datasheet).
Returns STATUS_INVALID_PARAM on bad data rate.
Status setRxBandwidth(double bw);Sets the receiver channel filter bandwidth (in kHz). Allowed bandwidth range: 58 to 812 kHz (assuming 26.0 MHz crystal frequency).
Returns STATUS_INVALID_PARAM on bad bandwidth.
void setOutputPower(int8_t power)Sets the RF output power (in dBm). Allowed output powers: -30, -20, -15, -10, 0, 5, 7 and 10 dBm.
Status transmit(uint8_t *data, size_t length, uint8_t addr = 0)Transmits the data. The addr parameter is used when the address filtering mode is enabled.
Returns STATUS_LENGTH_TOO_BIG when length parameter is greater than 255.
Status receive(uint8_t *data, size_t length, uint8_t addr = 0)Receives the data. The addr parameter is used when the address filtering mode is enabled.
Returns
STATUS_LENGTH_TOO_BIGwhen thelengthparameter is greater than 255STATUS_LENGTH_TOO_SMALLwhendatabuffor is to small to receive the entire packet
void setSyncMode(SyncMode mode)Sets the sync word mode.
SYNC_MODE_NO_PREAMBLE- Disables preamble and sync word transmission in TX and preamble and sync word detection in RX.SYNC_MODE_15_16- Enables 16-bit sync word transmission in TX and 16-bits sync word detection in RX. Only 15 of 16 bits need to match in RX.SYNC_MODE_16_16- Enables 16-bit sync word transmission in TX and 16-bits sync word detection in RX. All 16 bits need to match in RX.SYNC_MODE_30_32- Enables repeated sync word transmission in TX and 32-bits sync word detection in RX. Only 30 of 32 bits need to match in RX. The sync word will then be repeated twice.SYNC_MODE_NO_PREAMBLE_CS- Disables preamble and sync word transmission in TX and preamble and sync word detection in RX.SYNC_MODE_15_16_CS- Enables 16-bit sync word transmission in TX and 16-bits sync word detection in RX. Only 15 of 16 bits need to match in RX. Requires carrier sense above threshold in addition to sync word.SYNC_MODE_16_16_CS- Enables 16-bit sync word transmission in TX and 16-bits sync word detection in RX. All 16 bits need to match in RX. Requires carrier sense above threshold in addition to sync word.SYNC_MODE_30_32_CS- Enables repeated sync word transmission in TX and 32-bits sync word detection in RX. Only 30 of 32 bits need to match in RX. The sync word will then be repeated twice. Requires carrier sense above threshold in addition to sync word.
Status setPreambleLength(uint8_t length)Sets the preamble length (in bits). Allowed lengths: 16, 24, 36, 48, 64, 96, 128 and 192.
Returns STATUS_INVALID_PARAM on bad length.
void setSyncWord(uint16_t sync)Sets the 16-bit sync word.
void setPacketLengthMode(PacketLengthMode mode, uint8_t length = 255)Sets the packet length mode. Packet length types:
PKT_LEN_MODE_FIXED- Fixed packet length mode. The length field is not transmitted in TX andlengthparameter indicates the number of bytes that handler will accept in RX.PKT_LEN_MODE_VARIABLE- Variable packet length mode. The length field is transmitted in TX. The packet handler assumes that the first byte (after the sync word) is the length byte and receives the number of bytes indicated by its value. Thelengthparameter is used to set the maximum packet length allowed in RX. Any packet received with a length byte with a value greater thanlengthwill be discarded.
The library supports only packets up to 255 bytes.
void setAddressFilteringMode(AddressFilteringMode mode)Sets the address filtering mode.
ADDR_FILTER_MODE_NONE- Disables address transmission in TX and address checking in RX.ADDR_FILTER_MODE_CHECK- Enables address transmission in TX and address checking in RX. No broadcast address.ADDR_FILTER_MODE_CHECK_BC_0- Enables address transmission in TX and address checking in RX. Address 0 is broadcast address.ADDR_FILTER_MODE_CHECK_BC_0_255- Enables address transmission in TX and address checking in RX. Addresses 0 and 255 are broadcast addresses.
void setCrc(bool enable)Enables / disables CRC calculation in TX and CRC checking in RX.
The library was tested on Teensy 4.0.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent