XBee API operation library for mbed

Embed: (wiki syntax)

« Back to documentation index

XBeePins Class Reference

XBeePins Class Reference

Pin configuration information for XBee S1 modules. More...

#include <XBeePins.h>

Static Public Attributes

static PinP1_VCC = new Pin(1)
 Power supply.
static PinP2_DOUT = new Pin(2)
 DOUT, Output, UART data out.
static PinP3_DIN_CONFIG = new Pin(3)
 DIN / CONFIG(active low), Input, UART data In.
static PinP4_DO8 = new Pin(4)
 DO8, Either, Digital output 8, Function is not supported at the time of this release(18/05/2015).
static PinP5_RESET = new Pin(5)
 RESET(active low), Input, Module reset (reset pulse must be at least 200 ns).
static PinP6_RSSI_PWM0 = new Pin(6)
 PWM0 / RSSI, Either, PWM output 0 / RX signal strength indicator.
static PinP7_PWM1 = new Pin(7)
 PWM1, Either, PWM output 1.
static PinP8_RESERVED = new Pin(8)
 Reserved, Do not connect.
static PinP9_DTR_SLEEP_DIO8 = new Pin(9,"D8",0x0000)
 DTR(active low) / SLEEP_RQ/ DI8, Either, Pin sleep control line or digital input 8.
static PinP10_GND = new Pin(10)
 Ground.
static PinP11_AD4_DIO4 = new Pin(11,"D4",0x0010)
 AD4 / DIO4, Either, Analog input 4 or digital I/O 4.
static PinP12_CTS_DIO7 = new Pin(12,"D7",0x0080)
 CTS(active low) / DIO7 Either Clear-to-send flow control or digital I/O 7.
static PinP13_ON_SLEEP = new Pin(13)
 ON / SLEEP(active low), Output, Module status indicator.
static PinP14_VREF = new Pin(14)
 VREF, Input, Voltage reference for A/D inputs.
static PinP15_ASSOCIATE_AD5_DIO5 = new Pin(15,"D5",0x0020)
 Associate / AD5 / DIO5, Either, Associated indicator, analog input 5 or digital I/O 5.
static PinP16_RTS_AD6_DIO6 = new Pin(16,"D6",0x0040)
 RTS(active low) / DIO6, Either, Request-to-send flow control, or digital I/O 6.
static PinP17_AD3_DIO3 = new Pin(17,"D3",0x0008)
 AD3 / DIO3 Either Analog input 3 or digital I/O 3.
static PinP18_AD2_DIO2 = new Pin(18,"D2",0x0004)
 AD2 / DIO2 Either Analog input 2 or digital I/O 2.
static PinP19_AD1_DIO1 = new Pin(19,"D1",0x0002)
 AD1 / DIO1 Either Analog input 1 or digital I/O 1.
static PinP20_AD0_DIO0 = new Pin(20,"D0",0x0001)
 AD0 / DIO0 Either Analog input 0, digital I/O 0.

Detailed Description

Pin configuration information for XBee S1 modules.

Definition at line 9 of file XBeePins.h.


Field Documentation

Pin * P10_GND = new Pin(10) [static]

Ground.

Definition at line 42 of file XBeePins.h.

Pin * P11_AD4_DIO4 = new Pin(11,"D4",0x0010) [static]

AD4 / DIO4, Either, Analog input 4 or digital I/O 4.

Definition at line 45 of file XBeePins.h.

Pin * P12_CTS_DIO7 = new Pin(12,"D7",0x0080) [static]

CTS(active low) / DIO7 Either Clear-to-send flow control or digital I/O 7.

Definition at line 48 of file XBeePins.h.

Pin * P13_ON_SLEEP = new Pin(13) [static]

ON / SLEEP(active low), Output, Module status indicator.

Definition at line 51 of file XBeePins.h.

Pin * P14_VREF = new Pin(14) [static]

VREF, Input, Voltage reference for A/D inputs.

Definition at line 54 of file XBeePins.h.

Pin * P15_ASSOCIATE_AD5_DIO5 = new Pin(15,"D5",0x0020) [static]

Associate / AD5 / DIO5, Either, Associated indicator, analog input 5 or digital I/O 5.

Definition at line 57 of file XBeePins.h.

Pin * P16_RTS_AD6_DIO6 = new Pin(16,"D6",0x0040) [static]

RTS(active low) / DIO6, Either, Request-to-send flow control, or digital I/O 6.

Definition at line 60 of file XBeePins.h.

Pin * P17_AD3_DIO3 = new Pin(17,"D3",0x0008) [static]

AD3 / DIO3 Either Analog input 3 or digital I/O 3.

Definition at line 63 of file XBeePins.h.

Pin * P18_AD2_DIO2 = new Pin(18,"D2",0x0004) [static]

AD2 / DIO2 Either Analog input 2 or digital I/O 2.

Definition at line 66 of file XBeePins.h.

Pin * P19_AD1_DIO1 = new Pin(19,"D1",0x0002) [static]

AD1 / DIO1 Either Analog input 1 or digital I/O 1.

Definition at line 69 of file XBeePins.h.

Pin * P1_VCC = new Pin(1) [static]

Power supply.

Poor power supply can lead to poor radio performance, especially if the supply voltage is not kept within tolerance or is excessively noisy. To help reduce noise, we recommend placing a 1.0 μF and 8.2 pF capacitor as near as possible to pin 1 on the XBee. If using a switching regulator for the power supply, switching frequencies above 500 kHz are preferred. Power supply ripple should be limited to a maximum 100 mV peak to peak.

Definition at line 15 of file XBeePins.h.

Pin * P20_AD0_DIO0 = new Pin(20,"D0",0x0001) [static]

AD0 / DIO0 Either Analog input 0, digital I/O 0.

Definition at line 72 of file XBeePins.h.

Pin * P2_DOUT = new Pin(2) [static]

DOUT, Output, UART data out.

Definition at line 18 of file XBeePins.h.

Pin * P3_DIN_CONFIG = new Pin(3) [static]

DIN / CONFIG(active low), Input, UART data In.

Definition at line 21 of file XBeePins.h.

Pin * P4_DO8 = new Pin(4) [static]

DO8, Either, Digital output 8, Function is not supported at the time of this release(18/05/2015).

Definition at line 24 of file XBeePins.h.

Pin * P5_RESET = new Pin(5) [static]

RESET(active low), Input, Module reset (reset pulse must be at least 200 ns).

Definition at line 27 of file XBeePins.h.

Pin * P6_RSSI_PWM0 = new Pin(6) [static]

PWM0 / RSSI, Either, PWM output 0 / RX signal strength indicator.

Definition at line 30 of file XBeePins.h.

Pin * P7_PWM1 = new Pin(7) [static]

PWM1, Either, PWM output 1.

Definition at line 33 of file XBeePins.h.

Pin * P8_RESERVED = new Pin(8) [static]

Reserved, Do not connect.

Definition at line 36 of file XBeePins.h.

Pin * P9_DTR_SLEEP_DIO8 = new Pin(9,"D8",0x0000) [static]

DTR(active low) / SLEEP_RQ/ DI8, Either, Pin sleep control line or digital input 8.

Definition at line 39 of file XBeePins.h.