Package com.reduxrobotics.canand

Class CanandDeviceDetails.Msg

java.lang.Object
com.reduxrobotics.canand.CanandDeviceDetails.Msg
Enclosing class:
CanandDeviceDetails
public static class CanandDeviceDetails.Msg extends Object
Messages.

  • Field Details

    • kEnumerate

      public static final int kEnumerate
      Device enumerate response
      See Also:

    • kPartyMode

      public static final int kPartyMode
      Party mode
      See Also:

    • kStatus

      public static final int kStatus
      Status frame
      See Also:

    • kClearStickyFaults

      public static final int kClearStickyFaults
      Clear device sticky faults
      See Also:

    • kReportSetting

      public static final int kReportSetting
      setting value report from device
      See Also:

    • kSetSetting

      public static final int kSetSetting
      update setting on device
      See Also:

    • kSettingCommand

      public static final int kSettingCommand
      setting control command
      See Also:

    • kDlc_Enumerate

      public static final int kDlc_Enumerate
      ENUMERATE message length
      See Also:

    • kDlcMin_PartyMode

      public static final int kDlcMin_PartyMode
      PARTY_MODE message min length
      See Also:

    • kDlcMax_PartyMode

      public static final int kDlcMax_PartyMode
      PARTY_MODE message max length
      See Also:

    • kDlc_Status

      public static final int kDlc_Status
      STATUS message length
      See Also:

    • kDlcMin_ClearStickyFaults

      public static final int kDlcMin_ClearStickyFaults
      CLEAR_STICKY_FAULTS message min length
      See Also:

    • kDlcMax_ClearStickyFaults

      public static final int kDlcMax_ClearStickyFaults
      CLEAR_STICKY_FAULTS message max length
      See Also:

    • kDlc_ReportSetting

      public static final int kDlc_ReportSetting
      REPORT_SETTING message length
      See Also:

    • kDlc_SetSetting

      public static final int kDlc_SetSetting
      SET_SETTING message length
      See Also:

    • kDlcMin_SettingCommand

      public static final int kDlcMin_SettingCommand
      SETTING_COMMAND message min length
      See Also:

    • kDlcMax_SettingCommand

      public static final int kDlcMax_SettingCommand
      SETTING_COMMAND message max length
      See Also:

  • Method Details

    • extractEnumerate_Serial

      public static long extractEnumerate_Serial(long field)
      Extracts Device-unique serial number from Enumerate.
      Parameters:
      field - data bitfield
      Returns:
      serial as a buf:48

    • extractEnumerate_IsBootloader

      public static boolean extractEnumerate_IsBootloader(long field)
      Extracts Device is in bootloader. from Enumerate.
      Parameters:
      field - data bitfield
      Returns:
      is_bootloader as a bool

    • extractPartyMode_PartyLevel

      public static int extractPartyMode_PartyLevel(long field)
      Extracts Party level. 0 disables the strobe, whereas each increased value up to 10 increases strobe period by 50 ms. from PartyMode.
      Parameters:
      field - data bitfield
      Returns:
      party_level as a uint:8

    • extractStatus_DevSpecific

      public static long extractStatus_DevSpecific(long field)
      Extracts Device-specific status data. See device pages for more information. from Status.
      Parameters:
      field - data bitfield
      Returns:
      dev_specific as a buf:64

    • extractReportSetting_Address

      public static int extractReportSetting_Address(long field)
      Extracts Setting index to write to from ReportSetting.
      Parameters:
      field - data bitfield
      Returns:
      address as a enum:SETTING

    • extractReportSetting_Value

      public static long extractReportSetting_Value(long field)
      Extracts 6-byte setting value from ReportSetting.
      Parameters:
      field - data bitfield
      Returns:
      value as a buf:48

    • extractReportSetting_Flags

      public static int extractReportSetting_Flags(long field)
      Extracts Setting receive status from ReportSetting.
      Parameters:
      field - data bitfield
      Returns:
      flags as a bitset:8

    • extractSetSetting_Address

      public static int extractSetSetting_Address(long field)
      Extracts Setting index to write to from SetSetting.
      Parameters:
      field - data bitfield
      Returns:
      address as a enum:SETTING

    • extractSetSetting_Value

      public static long extractSetSetting_Value(long field)
      Extracts 6-byte setting value from SetSetting.
      Parameters:
      field - data bitfield
      Returns:
      value as a buf:48

    • extractSetSetting_Flags_Ephemeral

      public static boolean extractSetSetting_Flags_Ephemeral(long field)
      Extracts Whether the setting should be set ephemeral from SetSetting_Flags.
      Parameters:
      field - data bitfield
      Returns:
      ephemeral as a bool

    • extractSetSetting_Flags_SynchHold

      public static boolean extractSetSetting_Flags_SynchHold(long field)
      Extracts Whether the setting should be held until the next synch barrier from SetSetting_Flags.
      Parameters:
      field - data bitfield
      Returns:
      synch_hold as a bool

    • extractSetSetting_Flags_SynchMsgCount

      public static int extractSetSetting_Flags_SynchMsgCount(long field)
      Extracts Synch message count from SetSetting_Flags.
      Parameters:
      field - data bitfield
      Returns:
      synch_msg_count as a uint:4

    • extractSettingCommand_ControlFlag

      public static int extractSettingCommand_ControlFlag(long field)
      Extracts Setting command index from SettingCommand.
      Parameters:
      field - data bitfield
      Returns:
      control_flag as a enum:SETTING_COMMAND

    • extractSettingCommand_SettingIndex

      public static int extractSettingCommand_SettingIndex(long field)
      Extracts setting index to fetch from SettingCommand.
      Parameters:
      field - data bitfield
      Returns:
      setting_index as a enum:SETTING

    • constructEnumerate

      public static long constructEnumerate(long serial, boolean isBootloader)
      Constructs a ENUMERATE message.
      Parameters:
      serial - Device-unique serial number (buf:48)
      isBootloader - Device is in bootloader. (bool)
      Returns:
      message data as long

    • constructPartyMode

      public static long constructPartyMode(int partyLevel)
      Constructs a PARTY_MODE message.
      Parameters:
      partyLevel - Party level. 0 disables the strobe, whereas each increased value up to 10 increases strobe period by 50 ms. (uint:8)
      Returns:
      message data as long

    • constructStatus

      public static long constructStatus(long devSpecific)
      Constructs a STATUS message.
      Parameters:
      devSpecific - Device-specific status data. See device pages for more information. (buf:64)
      Returns:
      message data as long

    • constructClearStickyFaults

      public static long constructClearStickyFaults()
      Constructs a CLEAR_STICKY_FAULTS message.
      Returns:
      message data as long

    • constructReportSetting

      public static long constructReportSetting(int address, long value, int flags)
      Constructs a REPORT_SETTING message.
      Parameters:
      address - Setting index to write to (enum:SETTING)
      value - 6-byte setting value (buf:48)
      flags - Setting receive status (bitset:8)
      Returns:
      message data as long

    • constructSetSetting

      public static long constructSetSetting(int address, long value, boolean flagsEphemeral, boolean flagsSynchHold, int flagsSynchMsgCount)
      Constructs a SET_SETTING message.
      Parameters:
      address - Setting index to write to (enum:SETTING)
      value - 6-byte setting value (buf:48)
      flagsEphemeral - Whether the setting should be set ephemeral (bool)
      flagsSynchHold - Whether the setting should be held until the next synch barrier (bool)
      flagsSynchMsgCount - Synch message count (uint:4)
      Returns:
      message data as long

    • constructSettingCommand

      public static long constructSettingCommand(int controlFlag, int settingIndex)
      Constructs a SETTING_COMMAND message.
      Parameters:
      controlFlag - Setting command index (enum:SETTING_COMMAND)
      settingIndex - setting index to fetch (enum:SETTING)
      Returns:
      message data as long