smlPingerControl

Interface SMLPingerCommands

All Known Implementing Classes:

SMLAsciiCommands, SMLBinaryCommands

public interface SMLPingerCommands

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)

Method Detail

getSwitchOffCommand

byte[] getSwitchOffCommand()

Switches the pulse generation and timing off and performs a timed sequence power off.

Returns:

bytes (string or binary message) to write to serial port

getSwitchOnCommand

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.

Returns:

bytes (string or binary message) to write to serial port

togglePauseRun

byte[] togglePauseRun()

Toggles the Pinger pulse output state to either active or inactive without stopping the pulse timing or powering the device down

Returns:

bytes (string or binary message) to write to serial port

setPulseOnPeriod

byte[] setPulseOnPeriod(int tensMicros)

Changes the Pulse on period to the range checked value specified

Parameters:

tensMicros - may be 0 to 500 (x 0.0001Seconds)

Returns:

bytes (string or binary message) to write to serial port

setPulseRepRate

byte[] setPulseRepRate(int tenthsSeconds)

Changes the Pulse Repetition Rate to the range checked value specified

Parameters:

tenthsSeconds - may be 0 to 600 (x 0.1Seconds)

Returns:

bytes (string or binary message) to write to serial port

setPulseOnAndRepRate

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

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

byte[] setNumPulses(int nPulses)

Set the number of pulses to be transmitted

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

byte[] setPingFrequency(int pingCode)

Sets the Pinger Output Frequency selection

Parameters:

pingCode -
0 = No Pulse Output
1 = 150kHz
2 = 140kHz
3 = 130kHz

Returns:

bytes (string or binary message) to write to serial port

toggleAutoStatusUpdate

byte[] toggleAutoStatusUpdate()

Toggles Active or Inactive the automatic transmission of a Status message every 1 second

Returns:

bytes (string or binary message) to write to serial port

requestAdHocStatusUpdate

byte[] requestAdHocStatusUpdate()

Request the transmission of a single Pinger Status message

Returns:

bytes (string or binary message) to write to serial port

togglePreventSleep

byte[] togglePreventSleep()

Toggles an internal flag to enable / disable the micro-controller entering "Sleep" (low power mode)

Returns:

decreasePulseWidth

byte[] decreasePulseWidth()

Reduces the configured Pulse Width setting by a pre-set value of 100µSeconds until the minimum limit is reached

Returns:

increasePulseWidth

byte[] increasePulseWidth()

Increases the configured Pulse Width setting by a pre-set value of 100µSeconds until the maximum limit is reached

Returns:

bytes (string or binary message) to write to serial port

requestTemperature

byte[] requestTemperature()

Returns the current temperature measured by the Pinger

Returns:

bytes (string or binary message) to write to serial port