java.lang.Object
- org.deepjava.runtime.ppc32.Task
- - org.deepjava.runtime.mpc555.driver.BlueRS

All Implemented Interfaces:

Ippc32, Actionable
```
public class BlueRS
extends Task
```
Driver for the Stollmann BlueRS+I Bluetooth Module.
The module supports one emulated serial connection using the Bluetooth Serial Port Profile (SPP).
The device is connected to the second serial port of the mpc555. To test and configure the module, the Windows Hyperterminal can be used at a baud rate of 9600 kbps, no flow control. Stollmann provides the complete documentation at www.stollmann.de.

Connection Modes
There are 3 different modes in which the Bluetooth module can operate.
First there's the connection mode (MODE_CONNECTED). In this mode, data is sent (write(byte[], int)) and received (read(byte[])).
Secondly there's the AT command mode (MODE_AT). In this mode, the device can receive AT commands like connect(String) which are mainly used for connection handling. After power up, the module is in this mode. When in connection mode, the device can temporarily switch to AT mode and back again (MODE_CONNECTED_AT). The connection remains open in the background. To send commands like disconnect() to the module, the AT mode has to be entered. In normal connection mode, the device would not recognize the command and send it to its connection partner as normal text.
The last mode is for configuring the device. This mode is not used in normal operation and should only be used by experienced users.

Checking for Results
After sending a command to the Bluetooth module (e.g. connect(String)), the method getResult() can be called to check, if the command has been sent successfully. If the result code is RESULT_UNDEFINED, the command has not got the result from the Bluetooth module yet.
Starting the Driver
The start() method must been called first to start the BlueRS driver!

Author:

schlaepfer

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`MODE_AT`	Mode code for `getMode()`. The module can receive AT commands in this mode.
`static int`	`MODE_CONFIG`	Mode code for `getMode()`. The module can receive configuration commands in this mode.
`static int`	`MODE_CONNECTED`	Mode code for `getMode()`. If a connection between this module and another device is established, the module is in this mode.
`static int`	`MODE_CONNECTED_AT`	Mode code for `getMode()`. The module is still connected to another device, but can receive AT-commands.
`static int`	`RECEIVE_MTU`	The maximum number of bytes which can be sent in one packet.
`static int`	`RECEIVE_TASK_PERIOD`	The receiver task period.
`static int`	`RESULT_ERROR`	Result code for `getResult()`.
`static int`	`RESULT_OK`	Result code for `getResult()`.
`static int`	`RESULT_UNDEFINED`	Result code for `getResult()`.

Fields inherited from class org.deepjava.runtime.ppc32.Task
done, firstErr, maxNofTasks, nofActivations, period, safe, time

Fields inherited from interface org.deepjava.runtime.ppc32.Ippc32
CTR, DAR, DEC, DSISR, FPR0, FPR1, FPR10, FPR11, FPR12, FPR13, FPR14, FPR15, FPR16, FPR17, FPR18, FPR19, FPR2, FPR20, FPR21, FPR22, FPR23, FPR24, FPR25, FPR26, FPR27, FPR28, FPR29, FPR3, FPR30, FPR31, FPR4, FPR5, FPR6, FPR7, FPR8, FPR9, FPSCR, LR, MSR, R0, R1, R10, R11, R12, R13, R14, R15, R16, R17, R18, R19, R2, R20, R21, R22, R23, R24, R25, R26, R27, R28, R29, R3, R30, R31, R4, R5, R6, R7, R8, R9, SPR1, SPR18, SPR19, SPR22, SPR26, SPR268, SPR269, SPR27, SPR272, SPR273, SPR274, SPR275, SPR287, SPR8, SPR9, SPRG0, SPRG1, SPRG2, SPRG3, SRR0, SRR1, TBLread, TBUread, XER

Constructor Summary

Constructors
Constructor Description

BlueRS()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`action()`	Receive Task Do not call this method!
`static int`	`availableToReceive()`	Checks the number of bytes which are available to receive. If the device is not in `MODE_CONNECTED`, the result will be -1.
`static void`	`connect(byte[] connectTo)`	Connects to a device. See `connect(String)`.
`static void`	`connect(String connectTo)`	Connects to a device. To use this command, the device must be in `MODE_AT`.
`static void`	`connectionAccept()`	Accepts a initiated connection. Use `isConnectionInitiated()` to check if a connection has been initiated by a remote device.
`static void`	`disconnect()`	Disconnects the connection. To use this command, the device must be in `MODE_CONNECTED_AT`.
`static void`	`enableErrorMessages()`	Enables error messages from the Bluetooth module. In addition to the AT commands, the Bluetooth module will display error codes after each command.
`static int`	`getMode()`	Returns the current mode. The values are `MODE_AT, MODE_CONNECTED, MODE_CONNECTED_AT` and `MODE_CONFIG`
`static int`	`getResult()`	Returns the result of the last operation. The values are `RESULT_UNDEFINED, RESULT_OK or RESULT_ERROR`.
`static void`	`inquiry(boolean getServices)`	Starts an inquiry. To use this command, the device must be in `MODE_AT`.
`static boolean`	`isConnectionInitiated()`	Returns true if a connection has been initiated by a remote device. When a remote device wants to connect to this module, the module sends a "RING" command.
`static byte`	`read()`	Reads one byte from the device. This command must only be used in `MODE_CONNECTED` (see `getMode()`).
`static int`	`read(byte[] b)`	Reads data from the device. This command must only be used in `MODE_CONNECTED` (see `getMode()`).
`static void`	`reset()`	Sends a reset command to the module. To use this command, the device must be in `MODE_AT`.
`static void`	`returnFromATMode()`	Returns from AT-mode to connection-mode. To use this command, the device must be in `MODE_CONNECTED_AT`.
`static void`	`returnFromConfigMode()`	Returns from `MODE_CONFIG` to `MODE_AT`. To use this command, the device must be in `MODE_CONFIG`.
`static void`	`sendCommand(byte[] cmd)`	Sends a command to the Bluetooth module. See `sendCommand(String)`.
`static void`	`sendCommand(byte[] cmd, int off, int len)`	Sends a command to the Bluetooth module. Writes, if possible, `len` bytes starting at `offset` to this output stream.
`static void`	`sendCommand(String cmd)`	Sends a command to the Bluetooth module. To use this command, the device must be in `MODE_AT`.
`static void`	`start()`	Starts the BlueRS driver. This method must been called first to start the background task which is needed to receive and process characters from the Bluetooth device.
`static void`	`stop()`	Stops the BlueRS driver. If the driver is not used in a time critical application, there is no need to call this method.
`static void`	`switchToConfigMode()`	Switches from `MODE_AT` to `MODE_CONFIG`. To use this command, the device must be in `MODE_AT`.
`static void`	`switchToConnectedATMode()`	Switches from connection-mode to AT-mode `MODE_CONNECTED_AT`. To use this command, the device must be in `MODE_CONNECTED`. It is required to wait 1 second before using this command (no data transfer). Because the device is still connected but in AT-mode, the resulting mode will be `MODE_CONNECTED_AT` and not `MODE_AT`.
`static boolean`	`write(byte[] b, int len)`	Writes data to the device. This command must only be used in `MODE_CONNECTED` (see `getMode()`).

Methods inherited from class org.deepjava.runtime.ppc32.Task
install, remove, time

Methods inherited from class java.lang.Object
equals, getClass, hashCode, toString

- Field Detail
  - RECEIVE_TASK_PERIOD
```
public static final int RECEIVE_TASK_PERIOD
```
    The receiver task period.
    
    See Also:
    
    Constant Field Values
  - RECEIVE_MTU
```
public static final int RECEIVE_MTU
```
    The maximum number of bytes which can be sent in one packet.
    
    See Also:
    
    Constant Field Values
  - RESULT_UNDEFINED
```
public static final int RESULT_UNDEFINED
```
    Result code for getResult().
    
    See Also:
    
    Constant Field Values
  - RESULT_OK
```
public static final int RESULT_OK
```
    Result code for getResult().
    
    See Also:
    
    Constant Field Values
  - RESULT_ERROR
```
public static final int RESULT_ERROR
```
    Result code for getResult().
    
    See Also:
    
    Constant Field Values
  - MODE_AT
```
public static final int MODE_AT
```
    Mode code for getMode().
    The module can receive AT commands in this mode. After power-up or reset the module is in this mode.
    
    See Also:
    
    Constant Field Values
  - MODE_CONFIG
```
public static final int MODE_CONFIG
```
    Mode code for getMode().
    The module can receive configuration commands in this mode. In normal operation, this mode is not used.
    
    See Also:
    
    Constant Field Values
  - MODE_CONNECTED
```
public static final int MODE_CONNECTED
```
    Mode code for getMode().
    If a connection between this module and another device is established, the module is in this mode.
    
    See Also:
    
    Constant Field Values
  - MODE_CONNECTED_AT
```
public static final int MODE_CONNECTED_AT
```
    Mode code for getMode().
    The module is still connected to another device, but can receive AT-commands.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BlueRS
```
public BlueRS()
```
- Method Detail
  - sendCommand
```
public static void sendCommand(String cmd)
```
    Sends a command to the Bluetooth module.
    To use this command, the device must be in MODE_AT.
    After using this method, getResult() can be used to get the result of this operation.
    
    Parameters:
    
    cmd - the command to send
  - sendCommand
```
public static void sendCommand(byte[] cmd,
                               int off,
                               int len)
```
    Sends a command to the Bluetooth module.
    Writes, if possible, len bytes starting at offset to this output stream.
    
    Parameters:
    
    cmd - the byte array
    
    off - the start offset in the data.
    
    len - the number of bytes to write
  - sendCommand
```
public static void sendCommand(byte[] cmd)
```
    Sends a command to the Bluetooth module.
    See sendCommand(String).
    
    Parameters:
    
    cmd - the command to send
  - isConnectionInitiated
```
public static boolean isConnectionInitiated()
```
    Returns true if a connection has been initiated by a remote device.
    When a remote device wants to connect to this module, the module sends a "RING" command. Depending on the configuration of the module, the connection is accepted immediately or only if connectionAccept() is called.
    
    Returns:
    
    true if a connection has been initiated
  - connectionAccept
```
public static void connectionAccept()
```
    Accepts a initiated connection.
    Use isConnectionInitiated() to check if a connection has been initiated by a remote device.
  - inquiry
```
public static void inquiry(boolean getServices)
```
    Starts an inquiry.
    To use this command, the device must be in MODE_AT.
    
    Parameters:
    
    getServices - true if a list of the services of the found devices should be retrieved, else false
  - connect
```
public static void connect(String connectTo)
```
    Connects to a device.
    To use this command, the device must be in MODE_AT.
    If the device is connected getMode() returns MODE_CONNECTED. The result code will be RESULT_OK. If the target device does not respond, the result code will be RESULT_ERROR.
    
    Parameters:
    
    connectTo - This string represents a Bluetooth address (e.g. "0002ee36b272") or a previously inquired device (e.g. "d1").
  - connect
```
public static void connect(byte[] connectTo)
```
    Connects to a device.
    See connect(String).
    
    Parameters:
    
    connectTo - This byte array represents a Bluetooth address (e.g. "0002ee36b272") or a previously inquired device (e.g. "d1").
  - disconnect
```
public static void disconnect()
```
    Disconnects the connection.
    To use this command, the device must be in MODE_CONNECTED_AT.
  - switchToConnectedATMode
```
public static void switchToConnectedATMode()
```
    Switches from connection-mode to AT-mode MODE_CONNECTED_AT.
    To use this command, the device must be in MODE_CONNECTED.
    It is required to wait 1 second before using this command (no data transfer).
    Because the device is still connected but in AT-mode, the resulting mode will be MODE_CONNECTED_AT and not MODE_AT. Make shure the device is in that mode before using any other commands (e.g. disconnect().
  - switchToConfigMode
```
public static void switchToConfigMode()
```
    Switches from MODE_AT to MODE_CONFIG.
    To use this command, the device must be in MODE_AT.
  - returnFromATMode
```
public static void returnFromATMode()
```
    Returns from AT-mode to connection-mode.
    To use this command, the device must be in MODE_CONNECTED_AT.
  - returnFromConfigMode
```
public static void returnFromConfigMode()
```
    Returns from MODE_CONFIG to MODE_AT.
    To use this command, the device must be in MODE_CONFIG.
  - reset
```
public static void reset()
```
    Sends a reset command to the module.
    To use this command, the device must be in MODE_AT. Configuration mode may be entered after using this command.
  - availableToReceive
```
public static int availableToReceive()
```
    Checks the number of bytes which are available to receive.
    If the device is not in MODE_CONNECTED, the result will be -1.
    
    Returns:
    
    number of bytes which are available to receive or -1 if not in MODE_CONNECTED.
  - write
```
public static boolean write(byte[] b,
                            int len)
```
    Writes data to the device.
    This command must only be used in MODE_CONNECTED (see getMode()).
    
    Parameters:
    
    b - data to write to the device
    
    len - length of the data to write to the device
    
    Returns:
    
    true if the data has been sent, else false
  - read
```
public static int read(byte[] b)
```
    Reads data from the device.
    This command must only be used in MODE_CONNECTED (see getMode()).
    
    Parameters:
    
    b - the byte buffer to which the data will be written
    
    Returns:
    
    number of bytes read, -1 if the device is not connected or 0 if no data is available.
    If the number of bytes available will exceed the buffer size, only the buffer size is returned.
  - read
```
public static byte read()
```
    Reads one byte from the device.
    This command must only be used in MODE_CONNECTED (see getMode()).
    
    Returns:
    
    one byte from the device, -1 if the device is not connected or 0 if no data is available.
    If the number of bytes available will exceed the buffer size, only the buffer size is returned.
  - getResult
```
public static int getResult()
```
    Returns the result of the last operation.
    The values are RESULT_UNDEFINED, RESULT_OK or RESULT_ERROR. After calling a method which writes a command to the module (e.g. connect(String), the result will be RESULT_UNDEFINED. As soon as the module returns its status, the return value of getResult() will return RESULT_OK or RESULT_ERROR.
    
    Returns:
    
    the result of the last operation.
  - getMode
```
public static int getMode()
```
    Returns the current mode.
    The values are MODE_AT, MODE_CONNECTED, MODE_CONNECTED_AT and MODE_CONFIG
    
    Returns:
    
    the current mode.
  - action
```
public void action()
```
    Receive Task
    Do not call this method!
    
    Specified by:
    
    action in interface Actionable
    
    Overrides:
    
    action in class Task
  - start
```
public static void start()
```
    Starts the BlueRS driver.
    This method must been called first to start the background task which is needed to receive and process characters from the Bluetooth device.
  - stop
```
public static void stop()
```
    Stops the BlueRS driver.
    If the driver is not used in a time critical application, there is no need to call this method. It will remove the background task to receive and process characters from the Bluetooth device. After stop(), start() must be called to reactivate the driver.
  - enableErrorMessages
```
public static void enableErrorMessages()
```
    Enables error messages from the Bluetooth module.
    In addition to the AT commands, the Bluetooth module will display error codes after each command. A detailed description can be found in the Stollmann BlueRS+E/I manual (section 5.2). To display this error codes on the Target Log set dbg true.

Class BlueRS

Connection Modes

Checking for Results

Starting the Driver

Field Summary

Fields inherited from class org.deepjava.runtime.ppc32.Task

Fields inherited from interface org.deepjava.runtime.ppc32.Ippc32

Constructor Summary

Method Summary

Methods inherited from class org.deepjava.runtime.ppc32.Task

Methods inherited from class java.lang.Object

Field Detail

RECEIVE_TASK_PERIOD

RECEIVE_MTU

RESULT_UNDEFINED

RESULT_OK

RESULT_ERROR

MODE_AT

MODE_CONFIG

MODE_CONNECTED

MODE_CONNECTED_AT

Constructor Detail

BlueRS

Method Detail

sendCommand

sendCommand

sendCommand

isConnectionInitiated

connectionAccept

inquiry

connect

connect

disconnect

switchToConnectedATMode

switchToConfigMode

returnFromATMode

returnFromConfigMode

reset

availableToReceive

write

read

read

getResult

getMode

action

start

stop

enableErrorMessages