CC1200 Driver

Diff: CC1200.h

Revision:

4:c609cc7c9ea7

Parent:

2:2a447e8e50b8

Child:

5:d22a8885800b

--- a/CC1200.h	Mon Aug 10 01:47:24 2020 -0700
+++ b/CC1200.h	Fri Aug 28 15:39:31 2020 -0700
@@ -236,8 +236,10 @@
 	 * Enqueue a packet to be sent over the radio.  It will be sent the next time the radio is in
 	 * transmit state.
 	 *
-	 * The length of a packet is variable, from 1 byte to 127 bytes.  The length will be transmitted
-	 * along with the packet data.
+	 * In variable length mode, the length of a packet is variable, from 1 byte to 127 bytes.
+	 * The length will be transmitted along with the packet data.
+	 *
+	 * In fixed length mode, the length should be the fixed packet length.
 	 *
 	 * Also reads the radio's state.
 	 *
@@ -345,6 +347,54 @@
 	 */
 	void configureFIFOMode();
 
+	enum class PacketMode : uint8_t
+	{
+		/// Use fixed length packets.
+		VARIABLE_LENGTH = 0b1,
+		/// Use variable length packets, the length is encoded in the first byte of the packet.
+		FIXED_LENGTH = 0b0
+	};
+
+	/**
+	 * Set the packet mode that the system will use
+	 * @param mode
+	 */
+	void setPacketMode(PacketMode mode);
+
+	/**
+	 * Set the packet length when in fixed length packet mode.
+	 * The bit length parameter can be used to send only the x most significant bits of the final byte.
+	 * For example, if your packets are 20 bits long, you should set length to 2 bytes and bitLength to
+	 * 4 bytes, so that 2 complete bytes + 4 extra bits are transmitted.  Buffers used for sending and receiving packets
+	 * should then be 3 bytes long.
+	 * @param length
+	 */
+	void setPacketLength(uint8_t length, uint8_t bitLength = 0);
+
+private:
+	// current packet mode
+	PacketMode _packetMode;
+
+	// current packet length when in fixed length packet mode
+	uint8_t _packetTotalLength = 0; // length in bytes including final partial byte
+	uint8_t _packetByteLength = 0; // length in whole bytes
+	uint8_t _packetBitLength = 0; // extra bit length at end
+
+public:
+
+	/**
+	 * Set whether the CRC check is enabled.  This driver enables it by default.
+	 * Enabling CRC will cause a 16 bit checksum to be transmitted along with the packet.
+	 * It will be automatically checked by the receiving CC1200, and the packet will be discarded if the CRC
+	 * doesn't match.
+	 *
+	 * NOTE: it is not recommended to disable the CRC when using variable length mode.
+	 * If the length byte is corrupted and the CRC doesn't check this, then the driver could read
+	 * too little or too much from the chip's FIFO and cause the chip to enter the FIFO underflow state.
+	 * @param enabled
+	 */
+	void setCRCEnabled(bool enabled);
+
 	enum class ModFormat : uint8_t
 	{
 		FSK_2 = 0x0,
@@ -380,6 +430,18 @@
 	 */
 	void setOutputPower(float outPower);
 
+	// min power to use to turn the radio completely off
+	const static float ASK_MIN_POWER_OFF;
+
+	/**
+	 * Set the high and low output powers when transmitting in ASK mode.
+	 * Overrides the setOutputPower() power setting.
+	 * @param maxPower High output power.  Must be between -16dBm and +14dBm.
+	 * @param minPower Low output power.  Must be between maxPower and -17.5dBm.  -17.5dBm gives completely off,
+	 *     so OOK modulation instead of ASK.
+	 */
+	void setASKPowers(float maxPower, float minPower);
+
 	// Radio band for the chip to operate on.
 	// See user guide description for FS_CFG register.
 	enum class Band : uint8_t
@@ -514,8 +576,9 @@
 	};
 
 	/**
-	 * Set the length and shape of the power amplifier ramp-up curve.
+	 * Enable the the power amplifier ramp-up curve and set its shape and time.
 	 * See section 7.1 for details.
+	 * This is also used to set the ASK ramping between different power levels.
 	 *
 	 * The PA will gradually ramp from off to full amplitude in rampTime relative to the
 	 * symbol rate.  At 1/3 of rampTime it will have ramped to (firstRampLevel / 16) * full amplitude,
@@ -523,6 +586,11 @@
 	 */
 	void setPARampRate(uint8_t firstRampLevel, uint8_t secondRampLevel, RampTime rampTime);
 
+	/**
+	 * Disable the power amplifier ramp-up curve.
+	 */
+	void disablePARamping();
+
 	// Automatic Gain Control (AGC) Config
 	// ------------------------------------------------------------------------------
 
@@ -682,6 +750,11 @@
 	 */
 	void startRX() { sendCommand(Command::RX); }
 
+	/**
+	 * Send the radio into idle mode.  Stops a currently running tx or rx.
+	 */
+	void idle() { sendCommand(Command::IDLE); }
+
 private:
 
 	/**