SMLAsciiCommands

java.lang.Object
- smlPingerControl.SMLAsciiCommands

All Implemented Interfaces:

SMLPingerCommands
```
public class SMLAsciiCommands
extends java.lang.Object
implements SMLPingerCommands
```
ascii command set to send to SML Pinger

Author:

Doug Gillespie

Constructor Summary

Constructors
Constructor and Description

SMLAsciiCommands()

Constructors
Constructor and Description
`SMLAsciiCommands()`

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`decreasePulseWidth()` Reduces the configured Pulse Width setting by a pre-set value of 100µSeconds until the minimum limit is reached
`byte[]`	`getSwitchOffCommand()` Switches the pulse generation and timing off and performs a timed sequence power off.
`byte[]`	`getSwitchOnCommand()` Performs a three stage timed sequence power on and switches the pulse generation and timing on using either the default (upon initial power up) or last configured values for frequency and timings.
`byte[]`	`increasePulseWidth()` Increases the configured Pulse Width setting by a pre-set value of 100µSeconds until the maximum limit is reached
`byte[]`	`requestAdHocStatusUpdate()` Request the transmission of a single Pinger Status message
`byte[]`	`requestTemperature()` Returns the current temperature measured by the Pinger
`byte[]`	`setNumPulses(int nPulses)` Set the number of pulses to be transmitted
`byte[]`	`setPingFrequency(int pingCode)` Sets the Pinger Output Frequency selection
`byte[]`	`setPulseOnAndRepRate(int tensMicros, int tenthsSeconds)` Changes the Pulse On Period and Pulse Repetition Rate to the range checked values specified by tensMicros and tenthsSeconds respectively
`byte[]`	`setPulseOnPeriod(int tensMicros)` Changes the Pulse on period to the range checked value specified
`byte[]`	`setPulseRepRate(int tenthsSeconds)` Changes the Pulse Repetition Rate to the range checked value specified
`byte[]`	`toggleAutoStatusUpdate()` Toggles Active or Inactive the automatic transmission of a Status message every 1 second
`byte[]`	`togglePauseRun()` Toggles the Pinger pulse output state to either active or inactive without stopping the pulse timing or powering the device down
`byte[]`	`togglePreventSleep()` Toggles an internal flag to enable / disable the micro-controller entering "Sleep" (low power mode)

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

- Constructor Detail
  - SMLAsciiCommands
```
public SMLAsciiCommands()
```
- Method Detail
  - getSwitchOffCommand
```
public byte[] getSwitchOffCommand()
```
    Description copied from interface: SMLPingerCommands
    
    Switches the pulse generation and timing off and performs a timed sequence power off.
    
    Specified by:
    
    getSwitchOffCommand in interface SMLPingerCommands
    
    Returns:
    bytes (string or binary message) to write to serial port
  - getSwitchOnCommand
```
public byte[] getSwitchOnCommand()
```
    Description copied from interface: SMLPingerCommands
    
    Performs a three stage timed sequence power on and switches the pulse generation and timing on using either the default (upon initial power up) or last configured values for frequency and timings.
    
    Specified by:
    
    getSwitchOnCommand in interface SMLPingerCommands
    
    Returns:
    bytes (string or binary message) to write to serial port
  - togglePauseRun
```
public byte[] togglePauseRun()
```
    Description copied from interface: SMLPingerCommands
    
    Toggles the Pinger pulse output state to either active or inactive without stopping the pulse timing or powering the device down
    
    Specified by:
    
    togglePauseRun in interface SMLPingerCommands
    
    Returns:
    bytes (string or binary message) to write to serial port
  - setPulseOnPeriod
```
public byte[] setPulseOnPeriod(int tensMicros)
```
    Description copied from interface: SMLPingerCommands
    
    Changes the Pulse on period to the range checked value specified
    
    Specified by:
    
    setPulseOnPeriod in interface SMLPingerCommands
    
    Parameters:
    tensMicros - may be 0 to 500 (x 0.0001Seconds)
    
    Returns:
    bytes (string or binary message) to write to serial port
  - setPulseRepRate
```
public byte[] setPulseRepRate(int tenthsSeconds)
```
    Description copied from interface: SMLPingerCommands
    
    Changes the Pulse Repetition Rate to the range checked value specified
    
    Specified by:
    
    setPulseRepRate in interface SMLPingerCommands
    
    Parameters:
    tenthsSeconds - may be 0 to 600 (x 0.1Seconds)
    
    Returns:
    bytes (string or binary message) to write to serial port
  - setPulseOnAndRepRate
```
public byte[] setPulseOnAndRepRate(int tensMicros,
                          int tenthsSeconds)
```
    Description copied from interface: SMLPingerCommands
    
    Changes the Pulse On Period and Pulse Repetition Rate to the range checked values specified by tensMicros and tenthsSeconds respectively
    
    Specified by:
    
    setPulseOnAndRepRate in interface SMLPingerCommands
    
    Parameters:
    tensMicros - may be 0 to 500 (x 0.0001Seconds)
    tenthsSeconds - may be 0 to 600 (x 0.1Seconds)
    
    Returns:
    bytes (string or binary message) to write to serial port
  - setNumPulses
```
public byte[] setNumPulses(int nPulses)
```
    Description copied from interface: SMLPingerCommands
    
    Set the number of pulses to be transmitted
    
    Specified by:
    
    setNumPulses in interface SMLPingerCommands
    
    Parameters:
    nPulses - 0 = Continuous (default); 1 through to 65,535 = maximum number of pulses to transmit during this active/On session. Switching the Pinger Off then On again would start another session of nn puls
    
    Returns:
    bytes (string or binary message) to write to serial port
  - setPingFrequency
```
public byte[] setPingFrequency(int pingCode)
```
    Description copied from interface: SMLPingerCommands
    
    Sets the Pinger Output Frequency selection
    
    Specified by:
    
    setPingFrequency in interface SMLPingerCommands
    
    Parameters:
    pingCode -
    0 = No Pulse Output
    1 = 150kHz
    2 = 140kHz
    3 = 130kHz
    
    Returns:
    bytes (string or binary message) to write to serial port
  - toggleAutoStatusUpdate
```
public byte[] toggleAutoStatusUpdate()
```
    Description copied from interface: SMLPingerCommands
    
    Toggles Active or Inactive the automatic transmission of a Status message every 1 second
    
    Specified by:
    
    toggleAutoStatusUpdate in interface SMLPingerCommands
    
    Returns:
    bytes (string or binary message) to write to serial port
  - requestAdHocStatusUpdate
```
public byte[] requestAdHocStatusUpdate()
```
    Description copied from interface: SMLPingerCommands
    
    Request the transmission of a single Pinger Status message
    
    Specified by:
    
    requestAdHocStatusUpdate in interface SMLPingerCommands
    
    Returns:
    bytes (string or binary message) to write to serial port
  - togglePreventSleep
```
public byte[] togglePreventSleep()
```
    Description copied from interface: SMLPingerCommands
    
    Toggles an internal flag to enable / disable the micro-controller entering "Sleep" (low power mode)
    
    Specified by:
    
    togglePreventSleep in interface SMLPingerCommands
    
    Returns:
  - decreasePulseWidth
```
public byte[] decreasePulseWidth()
```
    Description copied from interface: SMLPingerCommands
    
    Reduces the configured Pulse Width setting by a pre-set value of 100µSeconds until the minimum limit is reached
    
    Specified by:
    
    decreasePulseWidth in interface SMLPingerCommands
    
    Returns:
  - increasePulseWidth
```
public byte[] increasePulseWidth()
```
    Description copied from interface: SMLPingerCommands
    
    Increases the configured Pulse Width setting by a pre-set value of 100µSeconds until the maximum limit is reached
    
    Specified by:
    
    increasePulseWidth in interface SMLPingerCommands
    
    Returns:
    bytes (string or binary message) to write to serial port
  - requestTemperature
```
public byte[] requestTemperature()
```
    Description copied from interface: SMLPingerCommands
    
    Returns the current temperature measured by the Pinger
    
    Specified by:
    
    requestTemperature in interface SMLPingerCommands
    
    Returns:
    bytes (string or binary message) to write to serial port

Class SMLAsciiCommands

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SMLAsciiCommands

Method Detail

getSwitchOffCommand

getSwitchOnCommand

togglePauseRun

setPulseOnPeriod

setPulseRepRate

setPulseOnAndRepRate

setNumPulses

setPingFrequency

toggleAutoStatusUpdate

requestAdHocStatusUpdate

togglePreventSleep

decreasePulseWidth

increasePulseWidth

requestTemperature