« Back to documentation index 
    
radio_driver Struct Reference 
The structure of a device driver for a radio in Contiki.  
More... 
#include <radio.h >
int(*  prepare  )(const void *payload, unsigned short payload_len)  Prepare the radio with a packet to be sent.   int(*  transmit  )(unsigned short transmit_len)  Send the packet that has previously been prepared.   int(*  send  )(const void *payload, unsigned short payload_len)  Prepare & transmit a packet.   int(*  read  )(void *buf, unsigned short buf_len)  Read a received packet into a buffer.   int(*  channel_clear  )(void)  Perform a Clear-Channel Assessment (CCA) to find out if there is a packet in the air or not.   int(*  receiving_packet  )(void)  Check if the radio driver is currently receiving a packet.   int(*  pending_packet  )(void)  Check if the radio driver has just received a packet.   int(*  on  )(void)  Turn the radio on.   int(*  off  )(void)  Turn the radio off.   radio_result_t(*  get_value  )(radio_param_t param, radio_value_t  *value)  Get a radio parameter value.   radio_result_t(*  set_value  )(radio_param_t param, radio_value_t  value)  Set a radio parameter value.   radio_result_t(*  get_object  )(radio_param_t param, void *dest, size_t size)  Get a radio parameter object.   radio_result_t(*  set_object  )(radio_param_t param, const void *src, size_t size)  Set a radio parameter object.   
Detailed Description 
The structure of a device driver for a radio in Contiki. 
Definition at line 225  of file radio.h .
Field Documentation 
Perform a Clear-Channel Assessment (CCA) to find out if there is a packet in the air or not. 
Definition at line 243  of file radio.h .
 
 
      
        
          radio_result_t(*  get_object )(radio_param_t param, void *dest, size_t size) 
         
      
 
Get a radio parameter object. 
The argument 'dest' must point to a memory area of at least 'size' bytes, and this memory area will contain the parameter object if the function succeeds. 
Definition at line 268  of file radio.h .
 
 
Get a radio parameter value. 
Definition at line 258  of file radio.h .
 
 
Turn the radio off. 
Definition at line 255  of file radio.h .
 
 
Turn the radio on. 
Definition at line 252  of file radio.h .
 
 
Check if the radio driver has just received a packet. 
Definition at line 249  of file radio.h .
 
 
      
        
          int(*  prepare )(const void *payload, unsigned short payload_len) 
         
      
 
Prepare the radio with a packet to be sent. 
Definition at line 230  of file radio.h .
 
 
      
        
          int(*  read )(void *buf, unsigned short buf_len) 
         
      
 
Read a received packet into a buffer. 
Definition at line 239  of file radio.h .
 
 
Check if the radio driver is currently receiving a packet. 
Definition at line 246  of file radio.h .
 
 
      
        
          int(*  send )(const void *payload, unsigned short payload_len) 
         
      
 
Prepare & transmit a packet. 
Definition at line 236  of file radio.h .
 
 
      
        
          radio_result_t(*  set_object )(radio_param_t param, const void *src, size_t size) 
         
      
 
Set a radio parameter object. 
The memory area referred to by the argument 'src' will not be accessed after the function returns. 
Definition at line 274  of file radio.h .
 
 
Set a radio parameter value. 
Definition at line 261  of file radio.h .
 
 
      
        
          int(*  transmit )(unsigned short transmit_len) 
         
      
 
Send the packet that has previously been prepared. 
Definition at line 233  of file radio.h .