SensorPort (JanosRuntime JavaDOC)

java.lang.Object
- com.integpg.sensor.SensorPort

```
public class SensorPort
extends Object
```

Constructor Summary

Constructors
Constructor and Description

SensorPort()

Constructors
Constructor and Description
`SensorPort()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static long[]`	`alarmingDeviceList()` This method requests the enumeration of external devices in the alarm state.
`void`	`close()` Closes an open Sensor Port.
`static int`	`CRC16(byte[] data, int offset, int count, int seed)` Perform CRC16 on an array of data elements based on the provided seed.
`static int`	`CRC8(byte[] data, int offset, int count, int seed)` Perform CRC8 on an array of data elements based on the provided seed.
`void`	`data(byte[] buf, int ofs, int len)` Performs 1-wire data exchange.
`static long[]`	`externalDeviceList()` This method requests the enumeration of external devices.
`protected void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`static double`	`get10vIn(int chan)` * This method is used to read the value of one 10 volt module input.
`static double`	`get10vOut(int chan)` * This method is used to read the value of one 10 volt module output.
`static double`	`get420In(int chan)`
`static double`	`get420Out(int chan)`
`long[]`	`getAlarmingDeviceList()` This method requests the enumeration of external devices in the alarm state.
`static int`	`getDeviceType(long addr)` Obtains the external device type from a device address.
`long[]`	`getExternalDeviceList()` This method requests the enumeration of external devices.
`static int`	`getOutputStates()` Obtains the state of all relay outputs as a single bit-mapped integer.
`static double`	`getRtdIn(int chan)` This method will return the RTD value for the given channel.
`static double`	`getTemp(int chan)` Returns the temperature value.
`static boolean`	`isOutputSet(int chan)` Obtains the state of a specified Relay Output.
`void`	`open()` Opens the Sensor Port providing exclusive access to external devices.
`static int[]`	`readAnalogInputs(long addr)` Obtain 16-bit raw values from a Type 20/FE/FD Quad Analog module.
`static byte[]`	`readDeviceBlock(long addr)` Obtains the Read Device Block from the external device.
`void`	`reset()` Issues the one-wire RESET pulse.
`void`	`select(long address)` Selects the external device by address.
`static void`	`set10vOut(int chan, double value)` sets the value of the output of a 10v module at the given channel.
`static void`	`set420Out(int chan, double value)` sets the value of the output of a 10v module at the given channel.
`static boolean`	`setOutputPulsed(int bits, int mask, int milliseconds)` Establishes a temporary condition for the specified output relays.
`static void`	`setOutputRelay(int chan, boolean state)` Establish the state of the specified output relay.
`static void`	`setOutputStates(int bits, int mask)` Establishes the condition for the specified output relays.
`static void`	`writeDeviceBlock(long addr, byte[] block)` Writes the Write Device Block to the external device.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SensorPort
```
public SensorPort()
```
- Method Detail
  - CRC8
```
public static int CRC8(byte[] data,
                       int offset,
                       int count,
                       int seed)
```
    Perform CRC8 on an array of data elements based on the provided seed. CRC8 is based on the polynomial = X^8 + X^5 + X^4 + 1. As used on the Dallas/Maxim 1-Wire bus
    
    Parameters:
    
    data - - byte array of data elements
    
    offset - - starting offset in the byte array
    
    count - - count of data elements to be included in the calculation
    
    seed - - initial CRC8 value
    
    Returns:
    
    - CRC8 calculation
  - CRC16
```
public static int CRC16(byte[] data,
                        int offset,
                        int count,
                        int seed)
```
    Perform CRC16 on an array of data elements based on the provided seed. CRC16 is based on the polynomial = X^16 + X^15 + X^2 + 1.
    
    Parameters:
    
    data - data byte array
    
    offset - starting offset in the byte array
    
    count - count of data elements to be included in the calculation
    
    seed - initial CRC16 value
    
    Returns:
    
    CRC16 calculation
  - getExternalDeviceList
```
public long[] getExternalDeviceList()
                             throws IOException
```
    This method requests the enumeration of external devices. The addresses returned are used to read/write these devices.
    
    Returns:
    
    A long[] of device addresses.
    
    Throws:
    
    IOException - The system must have access to the port.
  - getAlarmingDeviceList
```
public long[] getAlarmingDeviceList()
                             throws IOException
```
    This method requests the enumeration of external devices in the alarm state. The addresses returned are used to read/write these devices.
    
    Returns:
    
    A long[] of device addresses.
    
    Throws:
    
    IOException - The system must have access to the port.
  - getDeviceType
```
public static int getDeviceType(long addr)
```
    Obtains the external device type from a device address.
    
    Parameters:
    
    addr - the device address as returned by enumeration.
    
    Returns:
    
    The lease significant byte of the device address which indicates the device type.
  - open
```
public void open()
          throws IOException
```
    Opens the Sensor Port providing exclusive access to external devices. You MUST close the port as soon as possible to allow other processes access.
    
    Throws:
    
    IOException - If the port is already open.
  - close
```
public void close()
           throws IOException
```
    Closes an open Sensor Port.
    
    Throws:
    
    IOException - if the port is not open
  - reset
```
public void reset()
           throws IOException
```
    Issues the one-wire RESET pulse.
    
    Throws:
    
    IOException - If the port is not open.
  - select
```
public void select(long address)
            throws IOException
```
    Selects the external device by address.
    
    Parameters:
    
    address - Device address obtained by enumeration.
    
    Throws:
    
    IOException - If the port is not open.
  - data
```
public void data(byte[] buf,
                 int ofs,
                 int len)
          throws IOException
```
    Performs 1-wire data exchange.
    
    Parameters:
    
    buf - byte array with transmit/return data
    
    ofs - offset into byte array
    
    len - length of communications
    
    Throws:
    
    IOException - if the port is not open
  - getTemp
```
public static double getTemp(int chan)
                      throws IOException
```
    Returns the temperature value.
    
    Parameters:
    
    chan - Selects the temperature sensor channel.
    
    Returns:
    
    Temperature
    
    Throws:
    
    IOException - if the port is open
  - get10vIn
```
public static double get10vIn(int chan)
                       throws IOException
```
    * This method is used to read the value of one 10 volt module input.
    
    Parameters:
    
    chan - the channel of the 10 volt input. You can have 2 external 10 volt modules giving you 8 inputs. The channel must be 0 - 7.
    
    Returns:
    
    a scaled value based on the range that was configured using the Main JNIOR Web Page
    
    Throws:
    
    IOException - if the port is open
  - get10vOut
```
public static double get10vOut(int chan)
                        throws IOException
```
    * This method is used to read the value of one 10 volt module output.
    
    Parameters:
    
    chan - the channel of the 10 volt output. You can have 2 external 10 volt modules giving you 4 outputs. The channel must be 0 - 3.
    
    Returns:
    
    a scaled value based on the range that was configured using the Main JNIOR Web Page
    
    Throws:
    
    IOException - if the port is open
  - set10vOut
```
public static void set10vOut(int chan,
                             double value)
                      throws IOException
```
    sets the value of the output of a 10v module at the given channel.
    
    Parameters:
    
    chan - ?
    
    value - ?
    
    Throws:
    
    IOException - if the port is open
  - get420In
```
public static double get420In(int chan)
                       throws IOException
```
    Parameters:
    
    chan - channel to read
    
    Returns:
    
    value
    
    Throws:
    
    IOException - if the port is open
  - get420Out
```
public static double get420Out(int chan)
                        throws IOException
```
    Parameters:
    
    chan - channel to read
    
    Returns:
    
    value
    
    Throws:
    
    IOException - if the port is open
  - set420Out
```
public static void set420Out(int chan,
                             double value)
                      throws IOException
```
    sets the value of the output of a 10v module at the given channel.
    
    Parameters:
    
    chan - channel to set
    
    value - percentage
    
    Throws:
    
    IOException - if channel is open
  - getRtdIn
```
public static double getRtdIn(int chan)
                       throws IOException
```
    This method will return the RTD value for the given channel.
    
    Parameters:
    
    chan - channel to read
    
    Returns:
    
    value
    
    Throws:
    
    IOException - if port is open
  - externalDeviceList
```
public static long[] externalDeviceList()
                                 throws IOException
```
    This method requests the enumeration of external devices. The addresses returned are used to read/write these devices.
    
    Returns:
    
    A long[] of device addresses.
    
    Throws:
    
    IOException - if port is open
  - alarmingDeviceList
```
public static long[] alarmingDeviceList()
                                 throws IOException
```
    This method requests the enumeration of external devices in the alarm state. The addresses returned are used to read/write these devices.
    
    Returns:
    
    A long[] of device addresses.
    
    Throws:
    
    IOException - if port is open
  - readAnalogInputs
```
public static int[] readAnalogInputs(long addr)
                              throws IOException
```
    Obtain 16-bit raw values from a Type 20/FE/FD Quad Analog module.
    
    Parameters:
    
    addr - the device address as returned by enumeration. Note that full scale is 65520 for Type FD & FE 12-bit modules.
    
    Returns:
    
    An int[] containing four values 0-65535 corresponding to input channels 1 through 4.
    
    Throws:
    
    IOException - if the device is not an analog module with 4 input channels
  - readDeviceBlock
```
public static byte[] readDeviceBlock(long addr)
                              throws IOException
```
    Obtains the Read Device Block from the external device. The format is defined by the v2 JNIOR Communications Protocol.
    
    Parameters:
    
    addr - the device address as obtained by enumeration.
    
    Returns:
    
    A byte[] containing the Read Device Block as defined for the specific device type in the v2 JNIOR Communications Protocol.
    
    Throws:
    
    IOException - if port is open
  - writeDeviceBlock
```
public static void writeDeviceBlock(long addr,
                                    byte[] block)
                             throws IOException
```
    Writes the Write Device Block to the external device. The format is defined by the v2 JNIOR Communications Protocol.
    
    Parameters:
    
    addr - the device address as obtained by enumeration.
    
    block - the Write Device Block as defined in the v2 JNIOR Communications Protocol for the specific device type.
    
    Throws:
    
    IOException - if port is open
  - getOutputStates
```
public static int getOutputStates()
```
    Obtains the state of all relay outputs as a single bit-mapped integer.
    For the Model 410 the least significant 8 bits D0-D7 represent the state of ROUT1 through ROUT8. Bits D8-D11 will reflect the status of an option external 4ROUT module for relay outputs ROUT9 through ROUT12. A second external 4ROUT module if present is represented by bits D12-D15 for ROUT13 through ROUT16.
    For the Model 412 the least significant 12 bits D0-D11 represent the state of ROUT1 through ROUT12. Bits D12-D15 will reflect the status of an option external 4ROUT module for relay outputs ROUT13 through ROUT16.
    Note that some relays may be hardware jumper configured for Normally-Closed operation. These are set to Normally-Open by default. If a relay is set for normally-closed operation a '1' will indicate the OPRN condition.
    
    Returns:
    
    An integer where bits each correspond to relay outputs. A '1' is reported for outputs that are CLOSED and a '0' for those that are OPEN. The least significant bit corresponds to ROUT1.
  - isOutputSet
```
public static boolean isOutputSet(int chan)
```
    Obtains the state of a specified Relay Output.
    The channel is 0-based with 0 specifying ROUT1, 1 for ROUT2, etc. The Model 410 uses channels 0-7 as it supports ROUT1 through ROUT8. The Model 412 has 12 relay outputs which are specified as channels 0-11.
    Additional relay outputs may be available if external 4ROUT modules are present. For the Model 410 two external 4ROUT modules may be used. These can be addressed here as channels 8-15 representing ROUT9 through ROUT16. The Model 412 can use a single external module providing channels 12-15 for ROUT13 through ROUT16.
    
    Parameters:
    
    chan - 0-based value specifying a relay output channel
    
    Returns:
    
    true if the relay output is CLOSED. Returns false otherwise.
  - setOutputStates
```
public static void setOutputStates(int bits,
                                   int mask)
                            throws IOException
```
    Establishes the condition for the specified output relays. The selected relays are changed to the indicated state. Since external 4ROUT relay modules may be commanded this is synchronized with Sensor Port access.
    
    Parameters:
    
    bits - Integer where the bits indicate the desired output condition. A '1' resulting in a closed relay
    
    mask - Integer where the indicate which output relays are to be affected by the command. Those relays selected by a '1' will change to the state indicated by the bits parameter. Those corresponding with '0' bits will remain unchanged.
    
    Throws:
    
    IOException - if port is open
  - setOutputRelay
```
public static void setOutputRelay(int chan,
                                  boolean state)
                           throws IOException
```
    Establish the state of the specified output relay. Since external 4ROUT relay modules may be commanded this is synchronized with Sensor Port access. The channel is 0-based with 0 specifying ROUT1, 1 for ROUT2, etc. The Model 410 uses channels 0-7 as it supports ROUT1 through ROUT8. The Model 412 has 12 relay outputs which are specified as channels 0-11. Additional relay outputs may be available if external 4ROUT modules are present. For the Model 410 two external 4ROUT modules may be used. These can be addressed here as channels 8-15 representing ROUT9 through ROUT16. The Model 412 can use a single external module providing channels 12-15 for ROUT13 through ROUT16.
    
    Parameters:
    
    chan - 0-based value specifying a relay output channel
    
    state - true closes the associated relay illuminating the corresponding LED. false opens the relay. This opposite would be the case if a relay is hardware jumper configured for Normally-Closed operation.
    
    Throws:
    
    IOException - if port is open
  - setOutputPulsed
```
public static boolean setOutputPulsed(int bits,
                                      int mask,
                                      int milliseconds)
                               throws IOException
```
    Establishes a temporary condition for the specified output relays. The selected relays are changed to the indicated state for a duration specified in milliseconds. When this time period passes the relays are returned to their original states. This is used to pulse outputs with 1 millisecond resolution. Since external 4ROUT relay modules may be commanded this is synchronized with Sensor Port access.
    
    Parameters:
    
    bits - Integer where the least significant eight bits indicate the desired output condition. A '1' resulting in a closed relay
    
    mask - Integer where the least significant eight bits indicate which output relays are to be affected by the command. Those relays selected by a '1' will change to the state indicated by the data parameter. Those corresponding with '0' bits will remain unchanged.
    
    milliseconds - Integer specifying the duration that the new condition will be held. The pulse duration is to within 1 millisecond +0.2/-0.8
    
    Returns:
    
    Returns true if the pulse is successfully executed and false otherwise.
    
    Throws:
    
    IOException - if port is open
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    The finalize method in Object does nothing.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - [Need description!]

Class SensorPort

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SensorPort

Method Detail

CRC8

CRC16

getExternalDeviceList

getAlarmingDeviceList

getDeviceType

open

close

reset

select

data

getTemp

get10vIn

get10vOut

set10vOut

get420In

get420Out

set420Out

getRtdIn

externalDeviceList

alarmingDeviceList

readAnalogInputs

readDeviceBlock

writeDeviceBlock

getOutputStates

isOutputSet

setOutputStates

setOutputRelay

setOutputPulsed

finalize