Package me.clarius.sdk

Class ProbeSettings

java.lang.Object
me.clarius.sdk.ProbeSettings
public class ProbeSettings extends Object
Probe settings.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    alarmOnUndock
    Sound an alarm when probe comes out of charging dock.
    int
    autoBoot
    Auto boot probe when it comes out of deep sleep.
    int
    autoFreeze
    The number of seconds to engage freezing imaging after no contact mode has been engaged, valid range is 0 - 120, where 0 turns the function off.
    int
    bandwidthOptimization
    Flag allowing the system to adjust bandwidth parameters automatically when lag or dropped frames are determined.
    int
    contactDetection
    The number of seconds to engage a lower frame rate when no contact is detected, valid range is 0 - 30, where 0 turns the function off.
    int
    deepSleep
    The number of hours for probe to go into deep sleep, valid range is 0 - 96, where 0 disables deep sleep.
    ButtonSetting
    down
    Button down setting.
    ButtonHoldSetting
    downHold
    Button down hold setting.
    static final int
    FLAG_OFF
    Flag off.
    static final int
    FLAG_ON
    Flag on.
    int
    forceLogSend
    Flag allowing the probe to send logs while imaging.
    ButtonSetting
    handle
    Button handle setting.
    int
    htWifi
    Flag to enable 40 MHz bands for the probe's Wi-Fi network.
    int
    imageOnUndock
    Start imaging when probe comes out of charging dock.
    int
    keepAwake
    The number of minutes to power down the device once imaging has been frozen, valid range is 0 - 120, where 0 turns the function off.
    int
    keepAwakeCharging
    Flag to force the probe to stay powered while being charged.
    int
    powerFan
    Flag for the ability to use the power fan.
    int
    powerOn
    Flag allowing the probe's buttons to power the device on.
    int
    sounds
    Flag allowing the probe to make beeping sounds.
    int
    stationary
    The number of seconds to engage freezing imaging after being stationary for a specific time frame, valid range is 0 - 120, where 0 turns the function off.
    ButtonSetting
    up
    Button up setting.
    ButtonHoldSetting
    upHold
    Button up hold setting.
    int
    wakeOnShake
    Flag allowing the probe to start imaging when it is picked up while frozen.
    int
    wifiOptimization
    Flag allowing the probe to automatically freeze when poor wifi connectivity is detected.
    int
    wifiSearch
    Flag to force the probe to scan the networks and choose the appropriate channel before bringing up its Wi-Fi.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProbeSettings()
    Default constructor.
    ProbeSettings(int contactDetection, int autoFreeze, int keepAwake, int deepSleep, int stationary, int powerFan, int autoBoot, int wifiOptimization, int wifiSearch, int htWifi, int keepAwakeCharging, int powerOn, int sounds, int wakeOnShake, int bandwidthOptimization, int forceLogSend, int imageOnUndock, int alarmOnUndock, ButtonSetting up, ButtonSetting down, ButtonSetting handle, ButtonHoldSetting upHold, ButtonHoldSetting downHold)
    Constructor with parameters.

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • FLAG_OFF

      public static final int FLAG_OFF
      Flag off.

      Default: 0

      See Also:

    • FLAG_ON

      public static final int FLAG_ON
      Flag on.

      Default: 1

      See Also:

    • contactDetection

      public int contactDetection
      The number of seconds to engage a lower frame rate when no contact is detected, valid range is 0 - 30, where 0 turns the function off.

      Default: 3

    • autoFreeze

      public int autoFreeze
      The number of seconds to engage freezing imaging after no contact mode has been engaged, valid range is 0 - 120, where 0 turns the function off.

      Default: 30

    • keepAwake

      public int keepAwake
      The number of minutes to power down the device once imaging has been frozen, valid range is 0 - 120, where 0 turns the function off.

      Default: 15

    • deepSleep

      public int deepSleep
      The number of hours for probe to go into deep sleep, valid range is 0 - 96, where 0 disables deep sleep.

      Default: 3

    • stationary

      public int stationary
      The number of seconds to engage freezing imaging after being stationary for a specific time frame, valid range is 0 - 120, where 0 turns the function off.

      Default: 0

    • powerFan

      public int powerFan
      Flag for the ability to use the power fan.

      Default: FLAG_ON

    • autoBoot

      public int autoBoot
      Auto boot probe when it comes out of deep sleep.

      Default: FLAG_OFF

    • wifiOptimization

      public int wifiOptimization
      Flag allowing the probe to automatically freeze when poor wifi connectivity is detected.

      Default: FLAG_ON

    • wifiSearch

      public int wifiSearch
      Flag to force the probe to scan the networks and choose the appropriate channel before bringing up its Wi-Fi.

      Default: FLAG_OFF

    • htWifi

      public int htWifi
      Flag to enable 40 MHz bands for the probe's Wi-Fi network.

      Default: FLAG_OFF

    • keepAwakeCharging

      public int keepAwakeCharging
      Flag to force the probe to stay powered while being charged.

      Default: FLAG_OFF

    • powerOn

      public int powerOn
      Flag allowing the probe's buttons to power the device on.

      Default: FLAG_ON

    • sounds

      public int sounds
      Flag allowing the probe to make beeping sounds.

      Default: FLAG_ON

    • wakeOnShake

      public int wakeOnShake
      Flag allowing the probe to start imaging when it is picked up while frozen.

      Default: FLAG_OFF

    • bandwidthOptimization

      public int bandwidthOptimization
      Flag allowing the system to adjust bandwidth parameters automatically when lag or dropped frames are determined.

      Default: FLAG_OFF

    • forceLogSend

      public int forceLogSend
      Flag allowing the probe to send logs while imaging.

      Default: FLAG_OFF

    • imageOnUndock

      public int imageOnUndock
      Start imaging when probe comes out of charging dock.

      Default: FLAG_OFF

    • alarmOnUndock

      public int alarmOnUndock
      Sound an alarm when probe comes out of charging dock.

      Default: FLAG_OFF

    • up

      public ButtonSetting up
      Button up setting.

      Default: ButtonSetting.ButtonDisabled

    • down

      public ButtonSetting down
      Button down setting.

      Default: ButtonSetting.ButtonDisabled

    • handle

      public ButtonSetting handle
      Button handle setting.

      Default: ButtonSetting.ButtonDisabled

    • upHold

      public ButtonHoldSetting upHold
      Button up hold setting.

      Default: ButtonHoldSetting.ButtonHoldDisabled

    • downHold

      public ButtonHoldSetting downHold
      Button down hold setting.

      Default: ButtonHoldSetting.ButtonHoldDisabled

  • Constructor Details

    • ProbeSettings

      public ProbeSettings()
      Default constructor.

    • ProbeSettings

      public ProbeSettings(int contactDetection, int autoFreeze, int keepAwake, int deepSleep, int stationary, int powerFan, int autoBoot, int wifiOptimization, int wifiSearch, int htWifi, int keepAwakeCharging, int powerOn, int sounds, int wakeOnShake, int bandwidthOptimization, int forceLogSend, int imageOnUndock, int alarmOnUndock, ButtonSetting up, ButtonSetting down, ButtonSetting handle, ButtonHoldSetting upHold, ButtonHoldSetting downHold)
      Constructor with parameters.
      Parameters:
      contactDetection - The number of seconds to engage a lower frame rate when no contact is detected, valid range is 0 - 30, where 0 turns the function off.
      autoFreeze - The number of seconds to engage freezing imaging after no contact mode has been engaged, valid range is 0 - 120, where 0 turns the function off.
      keepAwake - The number of minutes to power down the device once imaging has been frozen, valid range is 0 - 120, where 0 turns the function off.
      deepSleep - The number of hours for probe to go into deep sleep, valid range is 0 - 96, where 0 disables deep sleep.
      stationary - The number of seconds to engage freezing imaging after being stationary for a specific time frame, valid range is 0 - 120, where 0 turns the function off.
      powerFan - Flag for the ability to use the power fan.
      autoBoot - Auto boot probe when it comes out of deep sleep.
      wifiOptimization - Flag allowing the probe to automatically freeze when poor wifi connectivity is detected.
      wifiSearch - Flag to force the probe to scan the networks and choose the appropriate channel before bringing up its Wi-Fi.
      htWifi - Flag to enable 40 MHz bands for the probe's Wi-Fi network.
      keepAwakeCharging - Flag to force the probe to stay powered while being charged.
      powerOn - Flag allowing the probe's buttons to power the device on.
      sounds - Flag allowing the probe to make beeping sounds.
      wakeOnShake - Flag allowing the probe to start imaging when it is picked up while frozen.
      bandwidthOptimization - Flag allowing the system to adjust bandwidth parameters automatically when lag or dropped frames are determined.
      forceLogSend - Flag allowing the probe to send logs while imaging.
      imageOnUndock - Start imaging when probe comes out of charging dock.
      alarmOnUndock - Sound an alarm when probe comes out of charging dock.
      up - Button up setting.
      down - Button down setting.
      handle - Button handle setting.
      upHold - Button up hold setting.
      downHold - Button down hold setting.