Package com.dsi.ant.message.fromhost
Class TransmitPowerMessage
java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.TransmitPowerMessage
Sets the power that the whole chip will transmit at.
- Since:
- 4.5
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The minimum transmit power value accepted by ANTstatic final int
The message content offset to the transmit power valuestatic final int
The number of bytes used for the transmit power valueFields inherited from class com.dsi.ant.message.AntMessage
BITMASK_CHANNEL_NUMBER, FILLER_BYTE, OFFSET_CHANNEL_NUMBER, RAW_OFFSET_MESSAGE_CONTENT_START, RAW_OFFSET_MESSAGE_ID, RAW_OFFSET_MESSAGE_SIZE, SIZE_CHANNEL_NUMBER, SIZE_FILLER_BYTE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
TransmitPowerMessage
(byte[] messageContent) TransmitPowerMessage
(int outputPowerLevelSetting, Capabilities capabilities) -
Method Summary
Modifier and TypeMethodDescriptionbyte[]
getMessageContent
(int channelNumber, int networkNumber) The content of the message with specified channel number and network number set if required.The unique type of this message based on its message id, contents, and intended channel type.toString()
Methods inherited from class com.dsi.ant.message.fromhost.AntMessageFromHost
createAntMessage, createAntMessage, getMessageContent, getMessageContent, getMessageId, getRawMessage, toStringHeader
Methods inherited from class com.dsi.ant.message.AntMessage
equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber
-
Field Details
-
OFFSET_TX_POWER
public static final int OFFSET_TX_POWERThe message content offset to the transmit power value- Since:
- 4.5
- See Also:
-
SIZE_TX_POWER
public static final int SIZE_TX_POWERThe number of bytes used for the transmit power value- Since:
- 4.5.
- See Also:
-
MIN_TRANSMIT_POWER_LEVEL
public static final int MIN_TRANSMIT_POWER_LEVELThe minimum transmit power value accepted by ANT- Since:
- 4.5
- See Also:
-
-
Constructor Details
-
TransmitPowerMessage
- Parameters:
outputPowerLevelSetting
- Which settings index to use to get actual power levelcapabilities
- Used to check the valid range of Transmit Power Level Settings- Since:
- 4.5
-
TransmitPowerMessage
protected TransmitPowerMessage(byte[] messageContent)
-
-
Method Details
-
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 classAntMessageFromHost
- Parameters:
channelNumber
- Written to the channel number byte if requirednetworkNumber
- Written to the network number byte if required- Returns:
- Message content raw byte array.
- Since:
- 4.5
-
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 classAntMessageFromHost
- Returns:
- The type of message returned by the host.
- Since:
- 4.5
-
toString
- Overrides:
toString
in classAntMessageFromHost
-