RF24.h

Go to the documentation of this file.

/*
 Copyright (C) 2011 J. Coliz <maniacbug@ymail.com>

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 version 2 as published by the Free Software Foundation.
 */

#ifndef __RF24_H__
#define __RF24_H__

#include <RF24_config.h>

typedef enum { RF24_PA_MIN = 0,RF24_PA_LOW, RF24_PA_HIGH, RF24_PA_MAX, RF24_PA_ERROR } rf24_pa_dbm_e ;

typedef enum { RF24_1MBPS = 0, RF24_2MBPS, RF24_250KBPS } rf24_datarate_e;

typedef enum { RF24_CRC_DISABLED = 0, RF24_CRC_8, RF24_CRC_16 } rf24_crclength_e;

class RF24
{
private:
  uint8_t ce_pin; 
  uint8_t csn_pin; 
  bool wide_band; /* 2Mbs data rate in use? */
  bool p_variant; /* False for RF24L01 and true for RF24L01P */
  uint8_t payload_size; 
  bool ack_payload_available; 
  bool dynamic_payloads_enabled; 
  uint8_t ack_payload_length; 
  uint64_t pipe0_reading_address; 
protected:
  void csn(int mode);

  void ce(int level);

  uint8_t read_register(uint8_t reg, uint8_t* buf, uint8_t len);

  uint8_t read_register(uint8_t reg);

  uint8_t write_register(uint8_t reg, const uint8_t* buf, uint8_t len);

  uint8_t write_register(uint8_t reg, uint8_t value);

  uint8_t write_payload(const void* buf, uint8_t len);

  uint8_t read_payload(void* buf, uint8_t len);

  uint8_t flush_rx(void);

  uint8_t flush_tx(void);

  uint8_t get_status(void);

  void print_status(uint8_t status);

  void print_observe_tx(uint8_t value);

  void print_byte_register(prog_char* name, uint8_t reg, uint8_t qty = 1);

  void print_address_register(prog_char* name, uint8_t reg, uint8_t qty = 1);

  void toggle_features(void);
public:
  RF24(uint8_t _cepin, uint8_t _cspin);

  void begin(void);

  void startListening(void);

  void stopListening(void);

  bool write( const void* buf, uint8_t len );

  bool available(void);

  bool read( void* buf, uint8_t len );

  void openWritingPipe(uint64_t address);

  void openReadingPipe(uint8_t number, uint64_t address);

  void setRetries(uint8_t delay, uint8_t count);

  void setChannel(uint8_t channel);

  void setPayloadSize(uint8_t size);

  uint8_t getPayloadSize(void);

  uint8_t getDynamicPayloadSize(void);
  
  void enableAckPayload(void);

  void enableDynamicPayloads(void);

  bool isPVariant(void) ;

  void setAutoAck(bool enable);

  void setAutoAck( uint8_t pipe, bool enable ) ;

  void setPALevel( rf24_pa_dbm_e level ) ;

  rf24_pa_dbm_e getPALevel( void ) ;

  bool setDataRate(rf24_datarate_e speed);
  
  rf24_datarate_e getDataRate( void ) ;

  void setCRCLength(rf24_crclength_e length);

  rf24_crclength_e getCRCLength(void);

  void disableCRC( void ) ;

  void printDetails(void);

  void powerDown(void);

  void powerUp(void) ;

  bool available(uint8_t* pipe_num);

  void startWrite( const void* buf, uint8_t len );

  void writeAckPayload(uint8_t pipe, const void* buf, uint8_t len);

  bool isAckPayloadAvailable(void);

  void whatHappened(bool& tx_ok,bool& tx_fail,bool& rx_ready);

  bool testCarrier(void);

  bool testRPD(void) ;

};

#endif // __RF24_H__
// vim:ai:cin:sts=2 sw=2 ft=cpp