com.alarexgroup.m2mplf.adapters.io
Class PinConfiguration

java.lang.Object
  com.alarexgroup.m2mplf.adapters.io.PinConfiguration

public class PinConfiguration
extends java.lang.Object

Pin configuration profile. With this profile you can set up parameters of respective pins.

Example of creating the pin configuration

PinConfiguration pinConf = new PinConfiguration();
pinConf.configurePin(0,PinConfiguration.PIN_MODE_OPEN,PinConfiguration.PIN_DIRECTION_INPUT);
pinConf.configurePin(1,PinConfiguration.PIN_MODE_OPEN,PinConfiguration.PIN_DIRECTION_INPUT);
pinConf.configurePin(1,PinConfiguration.PIN_MODE_OPEN,PinConfiguration.PIN_DIRECTION_OUTPUT);




Field Summary

static int	PIN_DIRECTION_INPUT Input orientation
static int	PIN_DIRECTION_OUTPUT Output orientation
static int	PIN_MODE_CLOSE Inactive pin
static int	PIN_MODE_OPEN Active pin
static int	TOTAL_NUMBER_OF_PINS Total number of all pins

Constructor Summary

PinConfiguration()
Creates configuration profile.

Method Summary

void	configurePin(int pinIndex, int pinMode, int pinDirection) Set up configuration of the specified pin.
void	configurePins(int[] pinIndexes, int pinMode, int pinDirectionInput) Global pin configuration.
int	getPinDirection(int pinIndex) Returns pin mode
int	getPinMode(int pinIndex) Returns working state of pin, whether it is opened or closed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOTAL_NUMBER_OF_PINS

public static final int TOTAL_NUMBER_OF_PINS

Total number of all pins

See Also:

Constant Field Values

PIN_MODE_CLOSE

public static final int PIN_MODE_CLOSE

Inactive pin

See Also:

Constant Field Values

PIN_MODE_OPEN

public static final int PIN_MODE_OPEN

Active pin

See Also:

Constant Field Values

PIN_DIRECTION_INPUT

public static final int PIN_DIRECTION_INPUT

Input orientation

See Also:

Constant Field Values

PIN_DIRECTION_OUTPUT

public static final int PIN_DIRECTION_OUTPUT

Output orientation

See Also:

Constant Field Values

Constructor Detail

PinConfiguration

public PinConfiguration()

Creates configuration profile.

Method Detail

configurePin

public void configurePin(int pinIndex,
                         int pinMode,
                         int pinDirection)

Set up configuration of the specified pin.

Parameters:

pinIndex - pinu id. Pins are numbered from 0-9: GPIO1 = 0; GPIO10 = 9

pinMode - pin status
PIN_MODE_OPEN - pin is opened and is active
PIN_MODE_CLOSE - pin is closed, not usable

pinDirection - pin mode
PIN_DIRECTION_OUTPUT - pin is output
PIN_DIRECTION_OUTPUT - pin is input

configurePins

public void configurePins(int[] pinIndexes,
                          int pinMode,
                          int pinDirectionInput)

Global pin configuration.

Parameters:

pinIndexes - array of pins

pinMode - pin status
PIN_MODE_OPEN - pin is opened and active
PIN_MODE_CLOSE - pin is closed, not usable

Warning, status will be the same for each pin in array

pinDirectionInput - Pin mode
PIN_DIRECTION_OUTPUT - pin is output
PIN_DIRECTION_OUTPUT - pin is input

Warning, mode will be the same for each pin in array

getPinDirection

public int getPinDirection(int pinIndex)

Returns pin mode

Parameters:

pinIndex - pin id

Returns:

pin mode
PIN_DIRECTION_OUTPUT - pin is output
PIN_DIRECTION_OUTPUT - pin is input

getPinMode

public int getPinMode(int pinIndex)

Returns working state of pin, whether it is opened or closed.

Parameters:

pinIndex - pin id

Returns:

pin status
PIN_MODE_OPEN - pin is opened and active
PIN_MODE_CLOSE - pin is closed, not usable