Package com.dsi.ant.message.fromhost

Class ChannelRfFrequencyMessage

java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.ChannelRfFrequencyMessage
public final class ChannelRfFrequencyMessage extends AntMessageFromHost
Configures the frequency this channel will operate on.
Since:
4.0

  • Field Details

    • OFFSET_RF_FREQUENCY

      public static final int OFFSET_RF_FREQUENCY
      The message content offset to the frequency value
      Since:
      4.0
      See Also:

    • SIZE_RF_FREQUENCY

      public static final int SIZE_RF_FREQUENCY
      The number of bytes used for the frequency value
      Since:
      4.0
      See Also:

    • MIN_RF_FREQUENCY

      public static final int MIN_RF_FREQUENCY
      The minimum frequency value ANT will accept
      Since:
      4.0
      See Also:

    • MAX_RF_FREQUENCY

      public static final int MAX_RF_FREQUENCY
      The maximum frequency value ANT will accept
      Since:
      4.0
      See Also:

    • RF_FREQUENCY_BASE_VALUE

      public static final int RF_FREQUENCY_BASE_VALUE
      The real world channel frequency (MHz) is calculated by taking the set value and adding it to this starting value.

      Real Channel Frequency = 2400 MHz + Channel RF Frequency Number

      Since:
      4.5
      See Also:

  • Constructor Details

    • ChannelRfFrequencyMessage

      public ChannelRfFrequencyMessage(int rfFrequency)
      Constructs the message from the given frequency value.
      Parameters:
      rfFrequency - The frequency offset of 2400 MHz (e.g. 50 MHz for 2450 MHz).
      Since:
      4.0

    • ChannelRfFrequencyMessage

      protected ChannelRfFrequencyMessage(byte[] messageContent)

  • Method Details

    • inRange

      public static final boolean inRange(int frequency)
      Determines if the frequency is within the acceptable range for ANT chips.
      Parameters:
      frequency - The frequency offset of 2400 MHz (e.g. 50 MHz for 2450 MHz) to be checked.
      Returns:
      True, if in range. False, otherwise.
      Since:
      4.0

    • getRealRfFrequency

      public static int getRealRfFrequency(int rfFrequencyOffset)
      Converts an ANT Channel RF Frequency value to the real world frequency.
      Parameters:
      rfFrequencyOffset - The set ANT Channel RF Frequency as an offset.
      Returns:
      The channel period in 1/32768ths of a second units.
      Since:
      4.5

    • getRealRfFrequency

      public int getRealRfFrequency()

    • getRfFrequencyOffset

      public static int getRfFrequencyOffset(int realRfFrequency)

    • getRfFrequency

      public int getRfFrequency()
      Gets the frequency (offset) value contained in the message.
      Returns:
      The frequency offset of 2400 MHz (e.g. 50 MHz for 2450 MHz)
      Since:
      4.0

    • getMessageContent

      public byte[] getMessageContent(int channelNumber, int networkNumber)
      Description copied from class: AntMessageFromHost
      The content of the message with specified channel number and network number set if required.
      Specified by:
      getMessageContent in class AntMessageFromHost
      Parameters:
      channelNumber - Written to the channel number byte if required
      networkNumber - Written to the network number byte if required
      Returns:
      Message content raw byte array.
      Since:
      4.0

    • getMessageType

      public MessageFromHostType getMessageType()
      Description copied from class: AntMessageFromHost
      The unique type of this message based on its message id, contents, and intended channel type.

      It is recommended to use this rather than the raw message ID.

      Specified by:
      getMessageType in class AntMessageFromHost
      Returns:
      The type of message returned by the host.
      Since:
      4.0

    • toString

      public String toString()
      Overrides:
      toString in class AntMessageFromHost