io.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
 * =======================================================================
 */

#ifndef XBEE_IO_H
#define XBEE_IO_H

#include "xbee/platform.h"
#include "xbee/device.h"
#include "xbee/atcmd.h"
#include "wpan/types.h"

XBEE_BEGIN_DECLS

/***
   @brief This structure stores broken-out I/O state for an XBee's configurable
   I/Os.

*/
typedef struct xbee_io_t {
   xbee_command_list_context_t
                     clc;           
   uint16_t          din_enabled;   
   uint16_t          dout_enabled;  
   uint16_t          din_state;     
   uint16_t          dout_state;    
   uint16_t          pullup_state;  
   uint16_t          pulldown_state;

   uint8_t           analog_enabled;
   uint16_t          adc_sample[8]; 
   uint16_t          sample_rate;   
   uint16_t          change_mask;   
   uint8_t           config[16];    
   uint16_t          pullup_enable; 
   uint16_t          pullup_direction; 
   uint16_t          pwm0_level;    
   uint16_t          pwm1_level;    
   uint8_t           pwm_timeout;   
   uint8_t           tx_samples;    
} xbee_io_t;

#define XBEE_IO_AD0                    0x0001
#define XBEE_IO_DIO0                   0x0001
#define XBEE_IO_AD1                    0x0002
#define XBEE_IO_DIO1                   0x0002
#define XBEE_IO_AD2                    0x0004
#define XBEE_IO_DIO2                   0x0004
#define XBEE_IO_AD3                    0x0008
#define XBEE_IO_DIO3                   0x0008
#define XBEE_IO_DIO4                   0x0010
#define XBEE_IO_DIO5                   0x0020
#define XBEE_IO_DIO6                   0x0040
#define XBEE_IO_DIO7                   0x0080
#define XBEE_IO_GPIO7                  0x0080
#define XBEE_IO_VCC_SENSE              0x80
#define XBEE_IO_DIO10                  0x0400
#define XBEE_IO_DIO11                  0x0800
#define XBEE_IO_DIO12                  0x1000


typedef XBEE_PACKED(xbee_frame_io_response_t, {
   uint8_t           frame_type;       
   addr64            ieee_address_be;        
   uint16_t          network_address_be;     
   uint8_t           options;
   uint8_t           num_samples;      
   uint16_t          data[1];          
}) xbee_frame_io_response_t;

enum xbee_io_type {
   XBEE_IO_TYPE_DISABLED = 0,             
   XBEE_IO_TYPE_SPECIAL = 1,              
   XBEE_IO_TYPE_ANALOG_INPUT = 2,         
   XBEE_IO_TYPE_DIGITAL_INPUT = 3,        
   XBEE_IO_TYPE_DIGITAL_OUTPUT_LOW = 4,   
   XBEE_IO_TYPE_DIGITAL_OUTPUT_HIGH = 5,  
   XBEE_IO_TYPE_TXEN_ACTIVE_LOW = 6,      
   XBEE_IO_TYPE_TXEN_ACTIVE_HIGH = 7,     

   XBEE_IO_TYPE_MASK = 0x0F,              

   XBEE_IO_TYPE_CHANGE_DETECT = 0x10,     
   XBEE_IO_TYPE_PULLUP = 0x20,            
   XBEE_IO_TYPE_PULLDOWN = 0x40,          
   XBEE_IO_FORCE = 0x80,            


   XBEE_IO_TYPE_DIGITAL_INPUT_PULLUP =
         XBEE_IO_TYPE_DIGITAL_INPUT | XBEE_IO_TYPE_PULLUP,
};


enum xbee_io_digital_output_state {
   XBEE_IO_SET_LOW = XBEE_IO_TYPE_DIGITAL_OUTPUT_LOW,    
   XBEE_IO_SET_HIGH = XBEE_IO_TYPE_DIGITAL_OUTPUT_HIGH,  

   XBEE_IO_FORCE_LOW = XBEE_IO_SET_LOW|XBEE_IO_FORCE,
   XBEE_IO_FORCE_HIGH = XBEE_IO_SET_HIGH|XBEE_IO_FORCE,
};


int xbee_io_response_parse( xbee_io_t FAR *parsed, const void FAR *source);
void xbee_io_response_dump( const xbee_io_t FAR *io);

#define XBEE_IO_ANALOG_INVALID      INT16_C(-32768)

#define XBEE_IO_MIN_SAMPLE_PERIOD   50

int xbee_io_get_digital_input( const xbee_io_t FAR *io, uint_fast8_t index);
int xbee_io_get_digital_output( const xbee_io_t FAR *io, uint_fast8_t index);
int16_t xbee_io_get_analog_input( const xbee_io_t FAR *io, uint_fast8_t index);
extern const FAR xbee_at_cmd_t xbee_io_cmd_by_index[];
int xbee_io_set_digital_output( xbee_dev_t *xbee, xbee_io_t FAR *io,
            uint_fast8_t index, enum xbee_io_digital_output_state state,
            const wpan_address_t FAR *address);
int xbee_io_configure( xbee_dev_t *xbee, xbee_io_t FAR *io,
            uint_fast8_t index, enum xbee_io_type type,
            const wpan_address_t FAR *address);
int xbee_io_set_options( xbee_dev_t *xbee, xbee_io_t FAR *io,
            uint16_t sample_rate, uint16_t change_mask,
            const wpan_address_t FAR *address);
int xbee_io_query( xbee_dev_t *xbee, xbee_io_t FAR *io,
            const wpan_address_t FAR *address);
int xbee_io_query_status( xbee_io_t FAR *io);

XBEE_END_DECLS

// If compiling in Dynamic C, automatically #use the appropriate C file.
#ifdef __DC__
   #use "xbee_io.c"
#endif

#endif