ANT_NET

ANT-FS Client Parameters. The application should initialize ALL fields of the configuration struct, otherwise, they will all be zero

Device serial number. Set to 0 to use the serial number of the USB device

Client device type (transmitted in beacon)

Client manufacturing ID (transmitted in beacon)

Radio frequency to use while in Link state.

Beacon Period, as described in the ANT-FS Technology specification

Indicates whether pairing authentication is enabled

Indicates whether upload functionality is supported

Indicates whether there is data available for download

Authentication type to include in beacon, as described in the ANT-FS Technology specification

Time, in seconds, that the client will wait without receiving any commands from the host before dropping to Link state. Set to 255 to disable. Zero is NOT a valid value.

Time, in seconds, that the client library will wait for a response from the application to a pairing request.

ANTFS_ClientParameters, with the default beacon parameters

Client device type Client manufacturing ID

Internal structure

Initial time

Desired timeout

ID of response we are waiting for

Flag to indicate whether we are waiting for a response or not

Configure a timeout to wait for a response

Response we are looking for Timeout, in miliseconds

Clear timeout

Check if the timeout has expired. Timeout is not triggered again, until enabled explicitly

True if the timeout has expired, false otherwise

ANT-FS Configuration Parameters

Authentication Timeout

Erase Timeout

Upload Request Timeout

Upload Response Timeout

Burst Check Timeout

ANT-FS Device Parameters

Remote device ID

Manufacturer ID of remote device

Remote device type

Authentication type supported by remote device

Status byte 1, as described in the ANT-FS Technology specification

Status byte 2, as described in the ANT-FS Technology specification

Configure specified device parameters

Device ID Manufacturer ID Device Type Authentication Type Status byte 1, as described in the ANT-FS Technology specification Status byte 2, as described in the ANT-FS Technology specification

Checks if the remote device is capable of the pairing authentication scheme

True if pairing is supported, false otherwise

Checks if the remote device supports uploads

True if uploads are supported, false otherwise

Checks if the remote device has data available for download

True if data is available, false otherwise

Obtains the beacon period of the remote device

Beacon period of the remote device

Obtains current state of the remote device

State of the remote device

Enables/disables the pairing bit in the device parameters

Set to true to enable pairing, false otherwise

Enables/disables the upload bit in the device parameters

Set to true to enable uploads, false otherwise

Enables/disables the data available bit in the device parameters

Set to true if there is data available for download, false otherwise

Returns a string with the decoded device parameters

String with decoded device parameters

Parameters retrieved by the host after finding a client matching its search criteria

Remote device parameters

Friendly name of the remote device

Returns a string with the decoded device parameters and friendly name

String with decoded device parameters and friendly name

ANT-FS Directory Contains information about the files available on a remote device

Directory Header

Number of entries contained in directory

Indexed entries in the directory

Creates an empty ANT-FS Directory structure

Creates an ANTFS_Directory object from downlaoded data

Directory file received on a download

Obtains the number of file entries contained in the directory

Directory file Number of file entries contained in directory

Decodes the directory and gets a list of files that need to be downloaded

Directory file Array containing the file indexes that need to be downloaded. Returns an empty array if there are no new files.

Looks up the requested directory entry

Directory file Zero-based entry number of the requested file (based on the order in which files are written in directory) Requested directory entry, or null if entry is not valid

Looks up the requested directory entry

Directory file Index of file to be looked up Requested directory entry, or null if entry is not valid

Retrieves the directory file header

Directory file Directory header structure. An exception is thrown if the file is too small to contain a header

Print directory

Formatted string with decoded directory

Obtains version of the directory

Formatted string with ANT-FS directory version

Parses general flags into a string

Flag byte Formatted string with decoded flags

Format of time used in directory

Bit mapped flags of file permissions

Directory header structure

The version of the Directory File Structure. The most significant 4 bits indicate major revision while the least significant 4 bits indicate a minor revision

The length of each structure, in bytes

Defines how the system will keep track of Date/Time stamps

Reserved bytes

Number of seconds elapsed since the system was powered up

The number of seconds elapsed since 00:00 in the morning of December 31, 1989. The value zero (0) specifies an unknown date. Values of less than 0x0FFFFFFF will be interpreted as being system time or some other custom time format (e.g. counter incremented every time directory entries are modified)

Directory file entry structure

Data file index

Data type of the file, which informs how to interpret the file

Part of the identifier field, used to uniquely identify a file. In .FIT, used to identify a sub type of the .FIT file type.

Part of the identifier field, used to uniquely identify a file. In .FIT, used to identify a particular instance of a file sub type.

File data type specific bit mapped flags

Bit mapped flags of file permissions

Size of file in bytes

Exceptions thrown by ANT-FS objects

An exception occuring in the ANT Managed Library

Prefixes given string with "ANTLibrary Exception: "

String to prefix

Prefixes given string with "ANTLibrary Exception: " and propates inner exception

String to prefix Inner exception

Copy constructor

ANTException to copy

Constructor

String to append to exception message

Prefixes given string with "ANTLibrary Exception: " and propagates inner exception

String to prefix Inner exception

Exceptions thrown by ANT-FS objects when a request to perform a specific operation failed Developers must ensure that these exceptions are handled appropiately to continue with the program execution

Constructor

Requested operation that failed ANT-FS Library return code

Constructor

Requested operation that failed

Return codes for ANT-FS operations

ANT-FS authentication types

ANT-FS disconnect command type

Helper class that prints human readable versions of the constants

Prints the description attribute of an enumeration value

Enumeration value to print Description string, e.g. "Operation successful"

Prints the name of an enumeration value

Enumeration value to print Named enumeration string, e.g. "ANTFS.ReturnCode.Pass"

ANT-FS Request Parameters These are the parameters received from the host along with a download/upload/erase request

File index of the requested download, upload or erase operation

Requested offset. The client library handles offsets internally, this is available for information purposes.

Maximum number of bytes the host can send/receive in a single block. The client library handles this internally, this is available for information purposes.

Maximum number of bytes that the host is requesting to upload. This includes the offset plus the total remaining bytes. This can be used to determine if there is enough space available in the device to handle the upload.

CRC Seed for the download. The client library handles this internally, this is available for information purposes

Indicates whether this is an initial download request or an attempt to resume a previous transfer. Resuming within a single session is handled by the library, this is available for information purposes.

ANT-FS Disconnect Parameters These are the parameters received from the host along with the disconnect command

Disconnect command type

Requested amount in time (in 30 s increments) to become undiscoverable

Requested application specific undiscoverable time

Application defined parameters for a download response

File index of requested download

Maximum number of bytes to send in a single block

Application defined parameters for an upload response

File index of requested upload

Maximum file size that can be stored in requested upload location

Maximum number of bytes that can be received in a single block

Status of an ongoing or completed data transfer

Constructor initializes status and obtains percentage from parameters

Current byte progress Expected data length

Provides a string containing the transfer status

Formatted string with the current byte progress, expected length and percentage

Current byte progress of a data transfer

Expected length of a data transfer

Current percentage of completion of a data transfer

Control class for an individual ANT channel. Created and accessed through the ANTDevice class.

Interface for an ANT channel. Allows classes to use different channel implementations behind the interface.

Returns the underlying C++ ANT framer reference that this channel uses for messaging. Useful to pass to unmanaged C++ implementations.

Pointer to the C++ ANT framer for messaging

Returns the channel number of this chanel

The channel number that is sent with messages on the ANT messaging layer

Returns current channel status. Throws exception on timeout.

Time to wait for device success response

Returns the channel ID Throws exception on timeout

Time to wait for device success response Assign channel

Assign an ANT channel along with its main parameters. Throws exception if the network number is invalid.

Channel Type byte Network to assign to channel, must be less than device's max networks-1 Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Assign channel (extended)

Assign an ANT channel, using extended channel assignment Throws exception if the network number is invalid.

Channel Type byte Network to assign to channel, must be less than device's max netwoks - 1 Extended assignment byte Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Unassign channel

Unassign this channel.

Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Set the Channel ID

Set the Channel ID of this channel. Throws exception if device type is > 127.

Device number to assign to channel. Set to 0 for receiver wild card matching Device pairing bit. Device type to assign to channel. Must be less than 128. Set to 0 for receiver wild card matching Transmission type to assign to channel. Set to 0 for receiver wild card matching Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Sets the Channel ID, using serial number as device number

Identical to setChannelID, except last two bytes of serial number are used for device number. Not available on all ANT devices. Throws exception if device type is > 127.

True on success. Note: Always returns true with a response time of 0 Sets channel message period

Set this channel's messaging period

Desired period in seconds * 32768 Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Sets the RSSI threshold (ARCT)

Set this channel's RSSI threshold (ARCT)

Desired RSSI threshold value Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Sets channel RF Frequency

Set this channel's RF frequency, with the given offset from 2400Mhz. Note: Changing this frequency may affect the ability to certify the product in certain areas of the world.

Offset to add to 2400Mhz Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Sets the channel transmission power

Set the transmission power of this channel Throws exception if device is not capable of per-channel transmit power.

Transmission power to set to Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Sets the channel search timeout

Set the search timeout

timeout in 2.5 second units (in newer devices 255=infinite) Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Opens the channel

Opens this channel

Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Sends broadcast message

Sends the given data on the broadcast transmission. Throws exception if data > 8-bytes in length

data to send (length 8 or less) Sends acknowledged message

Sends the given data as an acknowledged transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled Throws exception if data > 8-bytes in length

data to send (length 8 or less) Time in ms to wait for acknowledgement 0=fail, 1=pass, 2=timeout, 3=cancelled Sends burst transfer

Sends the given data as a burst transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled

data to send, can be any length Time in ms to wait for completion of transfer 0=fail, 1=pass, 2=timeout, 3=cancelled Sends extended broadcast message

Sends the given data as an extended broadcast transmission. Throws exception if data > 8-bytes in length

Device number of channel ID to send to Device type of channel ID to send to Transmission type of channel ID to send to data to send (length 8 or less) Sends extended acknowledged message

Sends the given data as an extended acknowledged transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled Throws exception if data > 8-bytes in length

Device number of channel ID to send to Device type of channel ID to send to Transmission type of channel ID to send to data to send (length 8 or less) Time in ms to wait for acknowledgement 0=fail, 1=pass, 2=timeout, 3=cancelled Sends extended burst data

Sends the given data as an extended burst transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled

Device number of channel ID to send to Device type of channel ID to send to Transmission type of channel ID to send to data to send, can be any length Time in ms to wait for completion of transfer 0=fail, 1=pass, 2=timeout, 3=cancelled Closes the channel

Close this channel

Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Sets the channel low priority search timeout

Sets the search timeout for the channel's low-priority search, where it will not interrupt other open channels. When this period expires the channel will drop to high-priority search. This feature is not available in all ANT devices.

Timeout period in 2.5 second units Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Adds a channel ID to the device inclusion/exclusion list

Add the given channel ID to the channel's inclusion/exclusion list. The channelID is then included or excluded from the wild card search depending on how the list is configured. Throws exception if listIndex > 3.

deviceNumber of the channelID to add deviceType of the channelID to add transmissionType of the channelID to add position in inclusion/exclusion list to add channelID at (Max size of list is 4) Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Configures the device inclusion/exclusion list

Configures the inclusion/exclusion list. If isExclusionList is true the channel IDs will be excluded from any wild card search on this channel. Otherwise the IDs are the only IDs accepted in the search. Throws exception if list size is greater than 4.

The desired size of the list, max size is 4, 0=none True = exclusion list, False = inclusion list Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Configures proximity search

Enables a one time proximity requirement for searching. Only ANT devices within the set proximity bin can be acquired. Search threshold values are not correlated to specific distances as this will be dependent on the system design. This feature is not available on all ANT devices. Throws exception if given bin value is > 10.

Threshold bin. Value from 0-10 (0= disabled). A search threshold value of 1 (i.e. bin 1) will yield the smallest radius search and is generally recommended as there is less chance of connecting to the wrong device. Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Configures the three operating RF frequencies for ANT frequency agility mode

This function configures the three operating RF frequencies for ANT frequency agility mode and should be used with the ADV_FrequencyAgility_0x04 extended channel assignment flag. Should not be used with shared, or Tx/Rx only channel types. This feature is not available on all ANT devices.

Operating RF frequency 1 Operating RF frequency 2 Operating RF frequency 3 Time to wait for device success response True on success. Note: Always returns true with a response time of 0

This event is fired whenever there are events on the device level that may impact the channel. Events that currently occur (Event, value of notification info Object): Reset, null Shutdown, null

The channel callback event for forwarding the raw msg struct. Triggered every time a message is received from the ANT device. Examples include transmit and receive messages. If you are coding in C# use the other response event version.

The channel callback event. Triggered every time a message is received from the ANT device. Examples include transmit and receive messages.

Returns the ANTDevice that this channel belongs to

Returns the underlying C++ ANT framer reference that this channel uses for messaging. Useful to pass to unmanaged C++ implementations.

Pointer to the C++ ANT framer for messaging

Returns the channel number of this instance

Dispose this channel.

Returns current channel status. Throws exception on timeout.

Time to wait for device success response

Returns the channel ID Throws exception on timeout

Time to wait for device success response Assign channel

Assign an ANT channel along with its main parameters. Throws exception if the network number is invalid.

Channel Type byte Network to assign to channel, must be less than device's max networks-1 Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Assign an ANT channel.

Channel Type byte Network to assign to channel Assign channel (extended)

Assign an ANT channel, using extended channel assignment Throws exception if the network number is invalid.

Channel Type byte Network to assign to channel, must be less than device's max netwoks - 1 Extended assignment byte Unassign channel

Unassign this channel.

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Unassigns this channel.

Set the Channel ID

Set the Channel ID of this channel. Throws exception if device type is > 127.

Device number to assign to channel. Set to 0 for receiver wild card matching Device pairing bit Device type to assign to channel. Set to 0 for receiver wild card matching Transmission type to assign to channel. Set to 0 for receiver wild card matching Sets the Channel ID, using serial number as device number

Identical to setChannelID, except last two bytes of serial number are used for device number. Not available on all ANT devices. Throws exception if device type is > 127.

True on success. Note: Always returns true with a response time of 0

Identical to setChannelID, except last two bytes of serial number are used for device number.

Sets channel message period

Set this channel's messaging period

Desired period in seconds * 32768 Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set this channel's messaging period

Desired period in seconds * 32768 Sets the RSSI threshold (ARCT)

Set this channel's RSSI threshold (ARCT)

Desired RSSI threshold value Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set this channel's RSSI threshold (ARCT)

Desired RSSI threshold value Sets channel RF Frequency

Set this channel's RF frequency, with the given offset from 2400Mhz. Note: Changing this frequency may affect the ability to certify the product in certain areas of the world.

Offset to add to 2400Mhz Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set this channel's RF frequency, with the given offset from 2400Mhz. Note: Changing this frequency may affect the ability to certify the product in certain areas of the world.

Offset to add to 2400Mhz Sets the channel transmission power

Set the transmission power of this channel Throws exception if device is not capable of per-channel transmit power.

Transmission power to set to Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the transmission power of this channel

Transmission power to set to Sets the channel search timeout

Set the search timeout

timeout in 2.5 second units (in newer devices 255=infinite) Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the search timeout

timeout in 2.5 second units (in newer devices 255=infinite) Opens the channel

Opens this channel

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Opens this channel

Sends broadcast message

Sends the given data on the broadcast transmission. Throws exception if data > 8-bytes in length

data to send (length 8 or less) Sends acknowledged message

Sends the given data as an acknowledged transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled Throws exception if data > 8-bytes in length

data to send (length 8 or less) Time in ms to wait for acknowledgement 0=fail, 1=pass, 2=timeout, 3=cancelled

Sends the given data as an acknowledged transmission. Throws exception if data > 8-bytes in length

data to send (length 8 or less) Sends burst transfer

Sends the given data as a burst transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled

data to send, can be any length Time in ms to wait for completion of transfer 0=fail, 1=pass, 2=timeout, 3=cancelled

Sends the given data as a burst transmission.

data to send, can be any length Sends extended broadcast message

Sends the given data as an extended broadcast transmission. Throws exception if data > 8-bytes in length

Device number of channel ID to send to Device type of channel ID to send to Transmission type of channel ID to send to data to send (length 8 or less) Sends extended acknowledged message

Sends the given data as an extended acknowledged transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled Throws exception if data > 8-bytes in length

Sends the given data as an extended acknowledged transmission. Throws exception if data > 8-bytes in length

Device number of channel ID to send to Device type of channel ID to send to Transmission type of channel ID to send to data to send (length 8 or less) Sends extended burst data

Sends the given data as an extended burst transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled

Sends the given data as an extended burst transmission.

Device number of channel ID to send to Device type of channel ID to send to Transmission type of channel ID to send to data to send, can be any length Closes the channel

Close this channel

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Close this channel

Sets the channel low priority search timeout

Timeout period in 2.5 second units Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Sets the timeout period for the channel's low-priority search, where it will not interrupt other open channels. When this period expires the channel will drop to high-priority search.

Timeout period in 2.5 second units Adds a channel ID to the device inclusion/exclusion list

deviceNumber of the channelID to add deviceType of the channelID to add transmissionType of the channelID to add Position in inclusion/exclusion list to add channel ID at (0..3) Time to wait for device success response True on success. Note: Always returns true with a response time of 0

The desired size of the list, max size is 4, 0=none True = exclusion list, False = inclusion list Enables channel encryption

Enables/disables channel encryption. Advanced bursting MUST be enabled before calling this command.

The desired encryption mode to be used, 1 is Enable, 2 is Enable with User Info String, 0 is Disable The encryption key to be used in volatile memory The decimation rate of the (slave channel period)/(master channel period). Must be 1 or greater on a slave channel, and value is N/A on a master channel. Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Enables/disables channel encryption. Advanced bursting MUST be enabled before calling this command.

Add ID to encryption ID list, which is also used for the search list.

The encryption ID to be added. Position in inclusion/exclusion list to add encryption ID at (0..3) Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Add ID to encryption ID list, which is also used for the search list.

The encryption ID to be added. Position in inclusion/exclusion list to add encryption ID at (0..3) Configures encryption list

Configures the white/black list. If isBlackList is true the encryption IDs will be prevented from connecting to this channel. Otherwise the IDs are the only IDs accepted by connection attempts. Throws exception if list size is greater than 4.

The desired size of the list, max size is 4, 0=none True = black list, False = white list Time to wait for device success response True on success. Note: Always returns true with a response time of 0

The desired size of the list, max size is 4, 0=none True = black list, False = white list Configures proximity search

Threshold bin. Value from 0-10 (0= disabled). A search threshold value of 1 (i.e. bin 1) will yield the smallest radius search and is generally recommended as there is less chance of connecting to the wrong device. Configures the three operating RF frequencies for ANT frequency agility mode

Operating RF frequency 1 Operating RF frequency 2 Operating RF frequency 3 Time to wait for device success response True on success. Note: Always returns true with a response time of 0

This function configures the three operating RF frequencies for ANT frequency agility mode and should be used with ADV_FrequencyAgility_0x04 channel assignment flag. Should not be used with shared, or Tx/Rx only channel types.

Operating RF frequency 1 Operating RF frequency 2 Operating RF frequency 3 Configures Selective Data Updates

Allows enabling Selective Data Update

Specify desired previously defined SDU mask and which messages it should apply to Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Allows enabling Selective Data Update

Specify desired previously defined SDU mask and which messages it should apply to Configures search sharing

Configures active channels with differing RF channels and/or network keys to share the active search time. The searchSharingCycles parameter defines the number of consecutive cycles each active search channel will receive before another search channel is interleaved. A value of 4 or greater is particularly recommended if search scan is enabled as well.

The number of cycles to run a scan on this channel before switching to another channel. Time to wait for device success response True on success. Note: Always returns true with a response time of 0

The number of cycles to run a scan on this channel before switching to another channel.

Sets the search priority for the channel. Channels with higher prioirities are scheduled for search first.

Desired priority level relative to other channel priorities. Higher priority values search before lower ones. Sets the search priority for the channel.

Sets the search priority for the channel. Channels with higher prioirities are scheduled for search first.

Desired priority level relative to other channel priorities. Higher priority values search before lower ones. Time to wait for device success response True on success. Note: Always returns true with a response time of 0

This event is fired whenever there are events on the device level that may impact the channel. Events that currently occur (Event, value of notification info Object): Reset, null Shutdown, null

The channel callback event. Triggered every time a message is received from the ANT device. Examples include transmit and receive messages.

Structure containing the data composing a channel ID

Device Number

Pairing Bit

Device Type ID

Transmission Type ID

Initializes a new Channel ID Object

Device Number Device Type ID Transmission Type ID

Control class for a given ANT device. An instance of this class is an open connection to the given ANT USB device. Handles creating channels and device setup.

Opens a connection to an ANT device attached by USB. Throws exception if a connection can not be established.

Attempts to open a connection to an ANT device attached by USB using the given deviceNum and baud rate Throws exception if a connection can not be established.

The device number of the ANT USB device (the first connected device starts at 0 and so on) The baud rate to connect at (AP2/AT3=57600, AP1=50000) Opens a connection to an ANT device attached by USB. Throws exception if a connection can not be established.

Attempts to open a connection to an ANT device attached by USB using the given deviceNum and baud rate Throws exception if a connection can not be established.

The type of connection to use when talking to the device If port type is USB, device number of the ANT USB device. If port type is COM this is the COM port number The baud rate to connect at (USB: AP2/AT3=57600, AP1=50000) The framing method to use for the connection to the chip. Needed for multimode chips and currently only supported on COM connections.

Automatically connects to first availiable ANTDevice. Throws exception if a connection can not be established. Will not auto find COM-connected devices.

Destructor closes all opened resources

Dispose method for explicit resource cleanup. Same as shutdownDeviceInstance() but doesn't nullify reference.

Shuts down all open resources, calls reset on the physical device, and nullifies the given ANTDevice and all its channels

ANTDevice to shutdown

Convert instance to a string including the USB device number the connection is on

Returns the pointer to the underlying C++ ANT Framer used for messaging

Pointer to C++ ANT Framer

Returns the device number used when this instance was opened Note: For some device types this number is not static and can change whenever new devices are enumerated in the system

Returns the baud rate used when this instance was opened

Returns the Frame Type used to open the device

Returns the Port Type used to open the device

Returns the requested ANTChannel or throws an exception if channel doesn't exist.

Channel number requested

Returns the number of ANTChannels owned by this device

Number of ant channels on device

Sets the cancel flag on all acknowledged and burst transfers in progress for the given amount of time. When these transmissions see the flag they will abort their operation and return as cancelled.

Time to set cancel flag for Returns the device capabilities

Returns the capabilities of this device. Throws an exception if capabilities are not received.

Force function to send request message to device Time to wait for device success response Last device capabilities received or a new copy if forceNewCopy is true

Returns the device capabilities of this device. Throws an exception if capabilities are not received.

Resets the USB device

Resets this USB device at the driver level

Resets the device and all its channels

Reset this device and all associated channels

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Reset this device and all associated channels

Sets a network key

Set the network key for the given network Throws exception if net number is invalid or network key is not 8-bytes in length

The network number to set the key for The 8-byte network key Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the network key for the given network Throws exception if net number is invalid or network key is not 8-bytes in length

The network number to set the key for The 8-byte network key Sets the transmit power for all channels

Set the transmit power for all channels of this device

Transmission power to set to Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the transmit power for all channels of this device

Transmission power to set to

When enabled advanced burst messages will be split into standard burst packets when received. This is disabled by default.

Whether to split advanced burst messages. True on success.

Configure advanced bursting for this device.

Whether to enable advanced bursting messages Maximum packet length allowed for bursting messages (valid values are 1-3) Features that the application requires the device to use Features that the device should use if it supports them Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Configure advanced bursting for this device.

Configure advanced bursting for this device including extended parameters.

Whether to enable advanced bursting messages Maximum packet length allowed for bursting messages (valid values are 1-3) Features that the application requires the device to use Features that the device should use if it supports them Maximum number of burst periods (~3.1ms) to stall for while waiting for the next message Number of times (multiplied by 5) to retry burst Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Configure advanced bursting for this device including extended parameters.

Whether to enable advanced bursting messages Maximum packet length allowed for bursting messages (valid values are 1-3) Features that the application requires the device to use Features that the device should use if it supports them Maximum number of burst periods (~3.1ms) to stall for while waiting for the next message Number of times (multiplied by 5) to retry burst

Set the encryption key in volatile memory.

The key index in volatile memory to load the memory key into The 128-bit encryption key Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the encryption key in volatile memory.

The key index in volatile memory to load the memory key into The 128-bit encryption key

Set the 4-byte encryption ID of the device.

4-byte encryption ID Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the 4-byte encryption ID of the device.

4-byte encryption ID

Set the 19-byte user information string of the device.

19-byte user information string Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the 19-byte user information string of the device.

19-byte user information string

Set the 16-byte random number seed for the device. To ensure cryptographic security, some devices require the random number seed to be inputed from a cryptographically secure RNG.

Cryptographically secure 16-byte RGN Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the 16-byte random number seed for the device. To ensure cryptographic security, some devices require the random number seed to be inputed from a cryptographically secure RNG.

Cryptographically secure 16-byte RGN

Set encryption information parameters.

0 - Encryption ID, 1 - User Information String, 2 - Random Number Seed 4-byte Encryption ID or 19-byte User Information String or 16-byte Random Number Seed Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set encryption information parameters.

0 - Encryption ID, 1 - User Information String, 2 - Random Number Seed 4-byte Encryption ID or 19-byte User Information String or 16-byte Random Number Seed

Load a saved encryption key from NVM into the volatile memory.

Index of NVM stored encryption key to load from (0..3) Index of volatile stored encryption key to copy to Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Load a saved encryption key from NVM into the volatile memory.

Index of NVM stored encryption key to load from (0..3) Index of volatile stored encryption key to copy to

Save an encryption key to NVM.

Index of NVM stored encryption key to store to (0..3) 16-byte encryption key Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Save an encryption key to NVM.

Index of NVM stored encryption key to store to (0..3) 16-byte encryption key

Load/Store Encryption Key from/in NVM

0 - Load encryption key from NVM or 1 - Store encryption key in NVM The index of the Encryption Key in NVM to be loaded or stored to depending on the selected operation (0..3) When Operation is set to 0x00: The index of the volatile key location that should be loaded with the NVM stored encryption key. When Operation is set to 0x01: The 128-bit Encryption Key to be stored to NVM Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Load/Store Encryption Key from/in NVM

Enables/Disables the LED flashing when a transmission event occurs

Desired state Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Enables/Disables the LED flashing when a transmission event occurs

Desired state Configures Event Buffering

Allows buffering of ANT events. Preset groups of events may be selected for buffering. Events may be buffered by size or time and buffering can be used in conjunction with filtering.

Selects which events are buffered Number of bytes that will be stored before a buffer flush occurs. Set to 0 to disable. Maximum time (in 10ms units) before a buffer flush occurs. Set to 0 to disable. Buffer size must also be set to a non zero value. Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Allows buffering of ANT events. Preset groups of events may be selected for buffering. Events may be buffered by size or time and buffering can be used in conjunction with filtering.

Allows filtering of specified ANT events. Filtering can be used in conjunction with buffering.

Bitfield of events to filter. Set Bit0 to filter event 0 etc. Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Allows filtering of specified ANT events. Filtering can be used in conjunction with buffering.

Bitfield of events to filter. Set Bit0 to filter event 0 etc. Configures High Duty Search

Allows configuring High Duty Search if no channels have been opened yet

Enable or disable High Duty Search Search period to suppress high duty search in units of 250ms. 0=Allow full time, 5=Suppress entirely Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Allows configuring High Duty Search if no channels have been opened yet

Enable or disable High Duty Search Search period to suppress high duty search in units of 250ms. 0=Allow full time, 5=Suppress entirely Allows defining a new Selective Data Update Mask

Allows defining a new Selective Data Update Mask

Identifier for the SDU Mask Rx Data Message Mask, 0=Ignore, 1=Update on Change Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Allows defining a new Selective Data Update Mask

Identifier for the SDU Mask Rx Data Message Mask, 0=Ignore, 1=Update on Change Configures User NVM

Allows configuring User NVM if available.

Nvm starting address Data block to write Size of data block Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Allows configuring User Nvm if available.

Nvm starting address Data block to write Size of data block Requests a message from the device and returns the response

Read User Nvm by sending Request Mesg capturing the response. Throws exception on timeout.

NVM Address to read from Number of bytes to read Time to wait for device success response

Read User Nvm by sending Request Mesg capturing the response. Throws exception on timeout.

NVM Address to read from Number of bytes to read

Obtains the PID (Product ID) of the USB device. Throws an exception if the PID is not received.

PID of the USB device.

Obtains the VID (Vendor ID) of the USB device

VID of the USB device

Returns the USB device serial number. This can be used to figure out the serial number if the option to use the USB device serial number was selected.

Client serial number Obtains the device USB Information

Obtains the USB information for the device Throws an exception if no information is received

USB Device Number USB Device Information

Obtains the USB information for the device Throws an exception if no information is received

USB Device Information Requests a message from the device and returns the response

Request a message from device and returns the response. Throws exception on timeout.

Channel to send request on Request to send Time to wait for device success response

Request a message from device on channel 0 and returns the response. Throws exception on timeout.

Request to send Time to wait for device success response Requests a message from the device

Request a message from device

Channel to send request on Request to send

Request a message from device

Request to send Set device in continuous scanning mode

Starts operation in continuous scanning mode. This allows the device to receive all messages matching the configured channel ID mask in an asynchronous manner. This feature is not available on all ANT devices.

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Starts operation in continuous scanning mode. This allows the device to receive all messages matching the configured channel ID mask in an asynchronous manner.

Initializes and starts CW test mode

Initialize and start CW test mode. This mode is to test your implementation for RF frequency requirements. The device will transmit an unmodulated carrier wave at the RF frequency of 2400Mhz + RFFreqOffset at the specified power level. This mode can then only be exited by a system reset. Note: When this function call returns false, the system will be reset automatically.

Transmission power to test at Offset to add to 2400Mhz Time to wait for response, used for both initialization and start command False if initialization or starting of CW test mode fails. On false, the system is automatically reset. This function encapsulates both ANT_InitCWTestMode and ANT_SetCWTestMode from the old library. It will automatically reset the system if either call fails. The given response time is used for both calls and the reset time is 500ms. So max wait time = responseTime*2 + 500ms Enables extended message reception

Enables extended message receiving. When enabled, messages received will contain extended data.

Desired State Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Enables extended message receiving. When enabled, messages received will contain extended data.

Desired State Enables the use of external 32kHz crystal

If the use of an external 32kHz crystal input is desired, this message must be sent once, each time a startup message is received

Time to wait for device success response True on success. Note: Always returns true with a response time of 0 Enabling an external 32kHz crystal input as a low power clock source saves ~85uA while ANT is active when compared to using the internal clock source.

If the use of an external 32kHz crystal input is desired, this message must be sent once, each time a startup message is received

Enabling an external 32kHz crystal input as a low power clock source saves ~85uA while ANT is active when compared to using the internal clock source.

Writes a message to the device, this function allows sending manually formatted messages.

msgID to write data buffer to write False if writing bytes to device fails Configure the device ANT library, ie: to send extra msg info

Configure the device ANT library, ie: to send extra msg info

Config flags Time to wait for response True on success. Note: Always returns true with a response time of 0

Configure the device ANT library, ie: to send extra msg info

Config flags Writes a SensRCore command to non-volatile memory

Writes a SensRcore command to non-volatile memory. Throws exception if command string length > 255, although commands will be much smaller

SensRcore command to write: [Cmd][CmdData0]...[CmdDataN], must be less than 256 bytes Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Writes a SensRcore command to non-volatile memory. Throws exception if command string length > 255.

SensRcore command to write: [Cmd][CmdData0]...[CmdDataN], must be less than 256 bytes Clears the NVM

Clears the non-volatile memory. NVM should be cleared before beginning write operations.

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Clears the non-volatile memory. NVM should be cleared before beginning write operations.

Sets the default SensRCore sector

Set the default sector which will be executed after mandatory execution of sector 0. This command has no effect if it is set to 0 or the Read Pins for Sector command appears in sector 0.

sector number to set as default Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Set the default sector which will be executed after mandatory execution of sector 0. This command has no effect if it is set to 0 or the Read Pins for Sector command appears in sector 0.

sector number to set as default Writes a sector break to NVM

Writes a sector break in the NVM image

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Writes a sector break in the NVM image

Request a dump of the device's script memory

Requests the device to return the current NVM contents through the device callback function. The end of the dump is signified by a 0x57 NVM_Cmd msg, which contains 0x04 EndDump code followed by a byte signifying how many instructions were read and returned.

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Locks the NVM contents

Locks the NVM so that it can not be read by the dump function. Can only be disabled by clearing the NVM.

Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Locks the NVM so that it can not be read by the dump function. Can only be disabled by clearing the NVM.

Sets the equipment state

Sets the equipment state. This command is specifically for use with the FIT1e module.

Fitness equipment state Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Sets the equipment state. This command is specifically for use with the FIT1e module.

Fitness equipment state

Adjusts the pairing distance settings. This command is specifically for use with the FIT1e module.

Minimum signal strength for a signal to be considered for pairing. Signal strength required for the FIT1e to pair with an ANT+ HR strap or watch An ANT+ device will unpair if the signal strength drops below this setting while in READY state or within the first 30 secons of the IN_USE state Time to wait for device success response True on success. Note: Always returns true with a response time of 0

Adjusts the pairing distance settings. This command is specifically for use with the FIT1e module.

The channel callback event. Triggered every time a message is received from the ANT device. Examples include requested responses and setup status messages.

This event is triggered when there is a serial communication error with the ANT Device. If the error is critical all communication with the device is dead and the device reference is sent in this function to allow the application to know which device is dead and to dispose of it.

ANTMessage struct as defined in unmanaged code for marshalling ant messages with unmanaged code

Message ID byte

Data buffer

Codes for the device notification event

The device is being reset

The device is being shutdown

Delegate for device response event

Message details received from device

Function to handle ANT_Device serial errors

The ANT_Device reporting the error The serial error that occured If true, the communication with the device is lost and this device object should be disposed

ANT Device Serial Error Codes

A write command to the device failed, could be a usb communication issue or due to invalid paramters passed to the write function. If it is a device communication failure, a serial read error will most likely occur shortly.

A failure occured reading data from the device.

Communication with the device has been lost.

A message received by the device failed the crc check and was discarded.

The message queue for received messages has overflowed and one or more messages were lost.

A message received was over the maximum message size, and the message was discarded. This is usually due to a communication error or an error in the library or library compilation settings.

A channel event was received for a channel which does not exist and the message was dropped (but will still appear in the logs)

Unspecified error, most likely a new or changed error definition

Container for all the device capability information, returned from an ANTDevice

Number of channels available

Number of simultaneous networks allowed

Number of SensRcore data channels available

Prints a string containing a formatted, readable version of all the capabilities

Prints a compact string containing a formatted, readable version of just the standard capabilities

Prints a string containing a formatted, readable version of all the advanced capabilities

Returns a formatted, readable string of all the capabilities

Basic Capabilities Masks (3rd Byte)

Advanced Capabilities Masks 1 (4th Byte)

Advanced Capabilities Masks 2 (5th Byte)

Advanced Capabilities Masks 3 (7th Byte)

Container for all the USB Device information, returned from an ANTDevice

USB Device Product Description

USB Device Serial String

Returns a formatted, readable string for the product description

Returns a formatted, readable string for the serial string

This is a static class that manages all the functions and variables common to the whole scope of the library.

Enables or disables all devices from resetting on startup, shutdown, and on CWTestMode Failure. Default = true.

Returns the number of ANT USB devices currently detected by the system.

Checks if the unmanaged library is present in the application's working directory. Throws an exception if the library is missing.

Checks if device specific libraries are present in the application's working directory. Throws an exception if any of these is missing.

Enables debug files

Initializes and enables debug logs for all devices Note: For application specific logs to work properly (e.g. ANT-FS logs), this needs to be called BEFORE creating an ANT Device.

Initializes and enables debug logs for all devices, and stores the log in the specified path. Note: For application specific logs to work properly (e.g. ANT-FS logs), this needs to be called BEFORE creating an ANT Device.

Debug log directory

Disables and closes the debug logs

Set the directory the log files are saved to. This string will prefix the file name so must end with a slash or will be part of the name. ie: directoryPath='c:\ANT\logs' will result in files being saved to the \ANT directory named logsdevice0.txt. Throws an exception if directory does not exist.

Path to directory to save log files in. Default is the running directory. This string will prefix the file name so must end with a slash or will be part of the name. ie: directoryPath='c:\ANT\logs' will result in files being saved to the \ANT directory named logsdevice0.txt.

Creates a debug log for the currently executing thread

Name of file (will result in ao_debug_name) True if successful

Adds an application specific message to the log for the current thread

Message to write to the log True on success

Contains all the ANT constants and enumerations for general use. Note: Where desired, in functions where enumerations are required, a byte type can be cast to the enumeration to feed the function raw byte values. IE: ANTDeviceInstance.RequestMessage((RequestMessageID)0x4E)); would compile.

Possible port connection types.

Possible framing modes. Use FramerType.basicANT unless you know you need to use another.

Channel Type flags. A valid channel type is one BASE parameter (Slave XOR Receive) combined by '|' (bitwise OR) with any desired ADV parameters

The int status codes returned by the acknowledged and broadcast messaging functions.

Basic Channel status message codes, the bottom two bits of the received status message

Transmit Power offsets

Startup message

Message ID to request message. Note: Where desired, raw byte values can be cast to the enum type. IE: (RequestMessageID)0x4E will compile.

Command Codes for SensRcore operations

Flags for configuring device ANT library

Flags for configuring advanced bursting features.

Event groups for configuring Event Buffering

MessageIDs for reference

*** CONFLICT: w/ Sensrcore, Fit1 will never have sensrcore enabled

EventIDs for reference

a pending transmit transfer has begun

returned on attempt to perform an action from the wrong channel state

returned on attempt to communicate on a channel that is not open

returned on attempt to open a channel without setting the channel ID

returned when attempting to start scanning mode

returned on attempt to communicate on a channel with a TX transfer in progress

returned when sequence number is out of order on a Burst transfer

returned if a data message is provided that is too large

returned when the message has an invalid parameter

returned when an invalid network number is provided

returned when the provided list ID or size exceeds the limit

returned when attempting to transmit on channel 0 when in scan mode

returned when an invalid parameter is specified in a configuration message

ANT event que has overflowed and lost 1 or more events

error writing to script

error accessing script page

the scripts are locked and can't be dumped

Fit1 only event added for timeout of the pairing state after the Fit module becomes active

Fit1 only

PIDs for reference

Container for all the information passed from an ANT device callback function

The object that created this response (ie: The corresponding ANTChannel or ANTDevice instance).

The channel parameter received in the message. Note: For some messages this is not applicable.

The time the message was received.

The MessageID of the response

The raw contents of the response message

Returns messageContents[2] cast to an ANTEventID. Throws an exception if this is not a channel event.

Returns messageContents[1] cast to an ANTMessageID. Throws an exception if this is not a response event.

Returns the 8-byte data payload of an ANT message. Throws an exception if this is not a received message.

Returns the burst sequence number (upper three bits of channel number). Throws exception if this is not a burst event.

Returns the channel ID portion of an extended message. Throws an exception if this is not an extended message.

Returns true if this is an extended message, false otherwise

Splits and returns the requested part of an extended message. Throws an exception if this is not an extended message.

The desired part of the message

Contains the information returned by a channel status request message

Bits 0-1 of the status response

Bits 2-3 of the status response. Invalid on AP1.

Bits 4-7 of the status response. Not a valid channelType on AP1.

Creates and fills the ChannelStatus

Control class for a given ANT device, with Integrated ANT-FS Client functionality. An instance of this class is an open connection to the given ANT USB device. Handles creating channels and device setup, and allows managing the file system (EEPROM) as well as configuring and controlling ANT-FS sessions.

Default timeout for responses

Queue with the responses received from ANT related to Integrated ANT-FS

Last received ANT Response

Device events

Flag indicating availabity of device events

Creates an Integrated ANT-FS Client object, by automatically trying to connect to the USB stick

Creates an Integrated ANT-FS Client object, specifying the USB device number. Baud rate is assumed to be 57600bps.

USB device number

Close connection to the ANT USB device

Get last ANT response

Message code of the last response

Send a raw ANT message

byte array, with the raw ANT message to send True if the message was written successfully

Wait for a message matching the desired pattern

Pattern to match time to wait, in ms True if the matching message is seen in the configured timeout

Compare a byte with a reference value

Byte to check (unsigned) Reference signed value Comparison result

Get the status of the ANT-FS session

MEMDEV initialization commands MUST be called after reset to set MEMDEV configuration prior to using FS Commands or requests. Init command must be called prior to issuing any FS command or requests. Currently, only SPI interface (min 2MHz rate) is supported with EEPROM devices. Configuration fields should be specified from information found from the EEPROM datasheet. Successful initialization results in FS_NO_ERROR response code.

Page Write Size is the physical page write boundary of the EEPROM Device. For EEPROM, this is considered the maximum number of bytes that can be written in one pass and it must be 2^x value. The address bytes configuration field specifies the required number of bytes used to address the physical memory location on the EEPROM. For example, a 1MBit EEPROM device requires 3 address bytes.

Initializes existing file system from saved directory information in NVM. Unsaved information on open files will be lost. Init command must be called prior to using any FS related commands or requests. Init command must also be called after issuing FS Format Memory. Also resets encryption key used for crypto operations. Successful initialization results in FS_NO_ERROR response code.

Command used to create a new empty file system. Any existing directory information and files will be discarded. Minimum number of sectors must be 2 (1 for directory and 1 for each file). Successful format operation results in FS_NO_ERROR response code. Number of Sectors * Num Pages per sector * Page Size must not exceed the size of the memory device. If inappropriate values are entered, format may succeed, but FS will be unusable.

Number of Sectors Num Pages per Sector. Defines sector size(X * page Size) Page Size is defined in MEMDEV_EEPROM_INIT for EEPROM Device

Save all open file information into the directory NVM. This should be called before device power off or any unsaved data will be lost. Successful save operation results in FS_NO_ERROR response code.

Rebuilds FS directory and condenses directory size by removing invalidated entries. Rebuilding directory also updates auto file index counter. Successful rebuild results in FS_NO_ERROR response code.

Delete existing open file. Delete permission must be set on file handle. On successful deletion (FS_NO_ERROR response code), the file handle is freed. If FS_MEMORY_WRITE_ERROR is returned, memory occupied by file is lost but the handle is freed. Any other response codes results in file deletion failure and the file handle remains associated to the open file.

File Handle Number

Close open flag or file. Any open file handle information is saved to the directory. FS_NO_ERROR response code is returned if file close operation is successful. Any other response code resulted in file close failure and the file handle still assigned to the file.

File Handle Number

Update application defined flags on file, but it is not saved to directory NVM. On success, FS_NO_ERROR is returned.

File Handle Number Specific Flags

When directory is locked, directory information is prevented from changing. When directory is unlocked, directory information is allowed to change. Attempting to lock a directory that is already locked will result in an error. Attempting to unlock a directory that is already unlocked will result in an error.

1 - Lock, 0 - Unlock FS Response

When this message ID is used in a command message, the specified starting value of the system time to be used in FS can be set. If successful, FS_NO_ERROR is returned

Current Time

Returns the FSResponse Byte when reponse != 0x00(NO_ERROR)

FS Response byte from Response Buffer

Returns number of used bytes in FS in sector sized increments. On success, returns FS_NO_ERROR response code and the used space value. If any other response code is returned, an invalid used space size value is returned (0xFFFFFFFF).

Used Space

Returns number of free bytes in FS in sector sized increments. On success, returns FS_NO_ERROR response code and the free space value. If any other response code is returned, an invalid free space size value is returned (0xFFFFFFFF).

Free Space

Return file index of first file in directory that matches specified identifier. On success, returns FS_NO_ERROR response code and the file index. If any other response code is returned, an invalid file index is returned (0x0000

File Data Type File Sub Type File Number File Index

Read from absolute offset into directory as if it were an ANTFS directory.

Offset Bytes Read Size

Returns ANTFS directory entry for the file matching the specified file index

ANTFS_DIR_ENTRY

Returns size in bytes as if it were an ANTFS directory (16-byte blocks). On success, returns FS_NO_ERROR response code and the ANTFS directory size value. If any other response code is returned, an invalid ANTFS directory size value is returned (0xFFFFFFFF).

Directory Size

Allocates a free sector and saves directory entry of the new file. If 0x0000 is supplied as file index, FS will auto generated a valid index for the file, otherwise a valid index must manually be supplied. If file creation is successful (FS_NO_ERROR is returned), the file index assigned to the created file is returned. Any other errors results in an invalid file index being returned (0x0000).

File Index File Data Type File Sub Type File Number File Data Type Specific Flags File General Flags

Open existing file in FS. By default, read and write pointers are set at the beginning of the file. If append flag is set in Open Flags parameter, then the write pointer is set to the end of the file. If file open is successful (FS_NO_ERROR, with the exceptions discussed in .FIT File and Crypto .FIT File), the file handle number is returned. Any other response code results in file open failure and the file handle returned being invalid (0xFF).

File Index Open Flags

Read from absolute offset into a file. File must be opened for reading beforehand. After reading, read pointers positioned at the end of the bytes read. On successful reads (FS_NO_ERROR), the returned number of bytes read as well as the payload is returned. Reading past the end of the directory results in FS_EOF_REACHED_ERROR, however the number of read bytes and the payload prior to reaching EOF is returned.

File Handle Number Offset Read Size

Read from current read pointer position in file. File must be opened for reading beforehand. After reading, read pointers positioned at the end of the bytes read.

File Handle Number Read Size

Write to absolute offset into a file. File cannot be written to if it was opened for reading. Write absolute cannot be used if file only opened for append operation. After writing, write positioned at the end of the bytes written.

File Handle Number Offset Write Payload

Write to current write pointer position in file. File cannot be written to if opened for reading.

File Handle Number Write Payload

Get size of open file in bytes. If successful, FS_NO_ERROR is returned along with the file size in bytes. If any other response code is returned, an invalid file size value is returned (0xFFFFFFFF).

File Handle Number File Size

Get size of the file in terms of the number of total bytes allocated to the file in the FS (size in memory). If successful, FS_NO_ERROR is returned along with the size in bytes. If any other response code is returned, an invalid file size value is returned (0xFFFFFFFF).

File handle Number

Gets the application defined flags of opened file. If successful, FS_NO_ERROR is returned along with the application defined flags on the file. If any other response code is returned, flag value of 0x00 is returned.

File Handle Number File Flags

When this message ID is used in a request message, the current system time used in FS is returned.

Current Time

Adds specified user key to be stored in internal memory. Keys are enumerated by Key Index. Up to 10 keys can be used. If successfully stored, FS_NO_ERROR is returned.

Key Index User Crypto Key FS Response

Specify stored user key (specified by Key Index) to be used by FS Encryption/Decryption process. Key remains active until reset, memory re-initialization via MESG_FS_INIT MEMORY or another key is specified. If key successfully selected, FS_NO_ERROR is returned

User Key Index FS Response

Specify non-stored user key to be used by FS Encryption/Decryption process. Key remains active until reset, memory re-initialization via MESG_FS_INIT_MEMORY or another key is specified. If key successfully set, FS_NO_ERROR is returned.d

User Crypto Key FS Response

When this command is issued, a file integrity check is performed on the selected .FIT file by calculating the file 2 byte CRC and comparing it versus the appended 2 byte CRC. If file integrity is intact, then FS_NO_ERROR is returned.Provided file handle must be pointing to a .FIT file (0x80 data type in file directory entry) as well as opened as read-only. Performing an integrity check on a non .FIT file and/or a write handle (write/erase/append open flags) is not allowed.

File Handle Number FS Response

Start ANTFS beacon.

FS Response

Stop ANTFS beacon.

FS Response

Configures the ANTFS Beacon properties.

Beacon Device Type ID Manufacturers ID Authentication Type Beacon Status FS Response

Set the Friendlyname

Friendlyname as a string FS Response

Sets the Passkey

Passkey as a string FS Response

Sets the ANTFS beacon status byte.

Bits 0 -2 are invalid FS Response

Command to respond to pairing request.

0 - Reject , 1 - Accept FS Response

Set the Beacon/Link RF frequency of the ANTFS connection

Channel Number 24xxMhz, xx as byte, 0xFF is to Disable FS Response

Configure timeout for ANTFS beacon.

Timeout in seconds FS Response

Configure timeout for ANTFS pairing process

Timeout in seconds FS Response

Enables or disables file creation in FS through ANTFS.

1 - Enable, 0 - Disable FS Response

Command to read ANTFS command pipe data.

Offset Read Size Read Size and Read Payload

Command to write ANTFS command pipe data.

Offset Bytes to be written Size written

Control class for an ANT-FS client channel. Handles creating channels and device setup, as well as the ANT-FS client implementation.

Constructor attempts to automatically detect an ANT USB device and open a connection to it

Destructor closes all opened resources

Dispose method for explicit resource cleanup

Close connection, and release all resources Inherit public finalizer from ANT_Device

Unpin and release buffer holding unmanaged data

Cancels any pending actions and returns the library to the appropriate ANTFS layer

Gets the version string of the underlying ANT-FS library

ANT-FS Library Version String

Returns the current library status

Current library status

Gets the host's friendly name string from the most recent session

Host friendly name

Gets the transfer data from the pucTransferBufferDynamic.

Data that will be uploaded in the specified file Offset where to write on the client file Size of the file that will be uploaded

Gets the full parameters for a download, upload or erase request from the host

Request parameters

Gets the file index for a download, upload or erase request from the host. If more details are desired, use GetRequestParameters().

Requested file index

Gets the transfer progress of a pending or complete download

The transfer status, including the current byte progress, total expected length of the download, and current percentage. Returns null if no valid status could be obtained.

Gets the parameters of a disconnect command requested by the host

Disconnect parameters

Configures the friendly name for the ANT-FS client

Client friendly name

Configures the passkey for a client to establish authenticated sessions with a host device, if passkey authentication is selected. If a passkey is not configured, all passkey authentication requests will be rejected.

Authentication passkey (max 255 bytes)

Set the channel ID of the ANT-FS client If this function is not used to explicitly configure the channel ID, the ANT-FS host will use the following defaults: Device type: 1 Transmission type: 5

Device type to assign to channel (ANT Channel ID) Transmission type to assign to channel (ANT Channel ID)

Sets a custom channel period for the ANT-FS beacon

Channel period, in 1/32768 counts

Set the network key for the ANT-FS client If this function is not used to explicitly configure the network key, the ANT-FS client will use the ANT-FS network key, as set in the base ANT Library, and network number 0. Configuration is applied when the beacon is open

network number 8-byte network key

Configures the transmit power for the ANT-FS channel, in case different power levels are desired in the link and connected states, for example, to allow the use of proximity search in a host device. If not configured, the transmit power will be set to 0dBm.

Transmit power to use while in Link state Transmit power to use after a connection has been established to a host

Enable pairing authentication

Selects whether pairing authentication is enabled or not in the device

Enable uploads

Selects whether upload functionality is supported

Indicate if data is available for download

Selects whether data is available for download

Configures the beacon timeout

Timeout, in seconds

Configures the pairing timeout

Timeout, in seconds

Sets up the ANT-FS client configuration parameters. This function can only be used while the beacon is not open. Individual parameters can be configured while the beacon is open If this function is not called, default beacon parameters are used.

SetPairingEnabled SetUploadEnabled SetDataAvailable SetBeaconTimeout SetPairingTimeout ANT-FS Client parameters

Begins the channel configuration to transmit the ANT-FS beacon. If the channel has already been configured (ANT-FS broadcast), the channel period needs to be specified in this function to let the client know the current period. If a channel period is not specified (0), the channel configuration is performed as specified in the beacon parameters.

Ends the ANT-FS session.

Set to true to return to broadcast (leave the channel open), and to false to close the channel.

Ends the ANT-FS session and closes the channel.

Sends a response to a pairing request.

Select whether to accept or reject the request

Sends a response to a request to erase a file from an authenticated remote device

The response to the erase request

Sends a response to a request to download a file to a host device

The response to the download request The file index to download The maximum number of bytes to send in a single block File to download. The entire file most be provided, even if the host requested an offset.

Sends a response to a request to download a file to a host device. Will attempt to send the entire download in a single block.

The response to the download request The file index to download File to download. The entire file most be provided, even if the host requested an offset.

Sends a response to a request to upload a file from a host device

The response to the upload request The file index to upload The maximum number of bytes to send in a single block The maximum file size.

Processing of incoming ANT-FS responses

The ANT-FS host callback event, triggered every time a response is received from the ANT-FS client library

ANT-FS Client Responses

!!! Must match the enum in antfs_client_channel.hpp

ANT-FS Client State

!!! Must match the enum in antfs_client_channel.hpp

ANT-FS Host

Creates ANT-FS object, response thread, and allocates unmanaged buffer for use with library

Destructor closes all opened resources

Dispose method for explicit resource cleanup

Copy back the current configuration parameters

Set current configuration parameters

Close connection, and release all resources

Unpin and release buffer holding unmanaged data

Set the channel ID of the ANT-FS host If this function is not used to explicitly configure the channel ID, the ANT-FS host will use the following defaults: Device type: 1 Transmission type: 5

Device type to assign to channel (ANT Channel ID). Set to 0 for receiver wild card matching Transmission type to assign to channel (ANT Channel ID). Set to 0 for receiver wild card matching

Set the channel period of the ANT-FS host. If this function is not used to explicitly configure the channel period, the ANT-FS host will use the default value of 8Hz

Desired period in seconds * 32768

Set the network key for the ANT-FS host If this function is not used to explicitly configure the network key, the ANT-FS host will use the ANT-FS network key, as set in the base ANT Library

network number 8-byte network key

Sets the value for the proximity bin setting for searching. If applying this value fails when attempting to start search, it is ignored to maintain compatibility with devices that do not support this feature. This means that a real failure can occur on a device that actually does support it, and it will be missed. The debug log will show if this command fails.

Desired proximity bin from 0-10

Sets the serial number of the host device.

4-byte host serial number

Clears the internal search device list

Adds a set of parameters for which to search to the internal search device list

Adds a set of parameters for which to search to the internal search device list, explicitly specifying all parameters and search mask.

Device parameter search mask. Set a member to zero (0) to wildcard search for it. Otherwise, set the bits that you want to be matched to 1 in each member. Note that the default search masks or wildcards should normally be applied to the ucStatusByte1 and ucStatusByte2 members of the search mask. Setting bits outside the masks, specially reserved bits, may lead to undesired behavior. Device Parameters to include in a search. Set the member to the desired search value. A member in this structure is ignored if the associated member in the Search Mask is set to zero (0) for wildcard. A handle to the search device entry. If the return value is zero (0), the function failed adding the device entry. This means that the device list is already full

Adds a set of parameters for which to search to the internal search device list, matching only the Device ID, Manufacturer ID and Device Type

Device ID to match Manufacturer ID to match Device type to match A handle to the search device entry. If the return value is zero (0), the function failed adding the device entry. This means that the device list is already full

Removes a device entry from the internal search list

Handle to the device entry to be removed from the list

Requests an ANT-FS session, from an already connected broadcast device.

The frequency of currently connected device This frequency is calculated as (ucSearchRadioFrequency_ * 1 MHz + 2400 MHz). The frequency on which the connection communication will occur. This frequency is calculated as (ucSearchRadioFrequency_ * 1 MHz + 2400 MHz). Begins a search for ANT-FS remote devices Throws an exception if the library is in the wrong state or busy with another request

Begins a search for ANT-FS remote devices Throws an exception if the library is in the wrong state or busy with another request

The frequency on which to search for devices. This frequency is calculated as (ucSearchRadioFrequency_ * 1 MHz + 2400 MHz). The frequency on which the connection communication will occur. This frequency is calculated as (ucSearchRadioFrequency_ * 1 MHz + 2400 MHz) Device number to assign to channel (ANT Channel ID) Selects whether to search for broadcast devices, and request the beacon

Begins a search for ANT-FS remote devices. The search will continue until a device is found, the Cancel() function is called, an error occurs, or the library is closed. Throws an exception if the library is in the wrong state or busy with another request

Begins a search for ANT-FS remote devices, using the default ANT-FS search frequency (2.450GHz) and an adaptive frequency hopping scheme when the connection is established. The host will continue to search for devices until a device is found, the Cancel() function is called, an error occurs, or the library is closed. Throws an exception if the library is in the wrong state or busy with another request

Disconnect from a remote device, going back to the state specified by the disconnect type. Throws an exception if the library is in the wrong state or busy with another request

Disconnect from a remote device. Optionally put that device on a blackout list for a period of time Throws an exception if the library is in the wrong state or busy with another request

Number of seconds the device ID should remain on the blackout list. If set to BlackoutTime.None, the device is not put in a blackout list. If set to BlackoutTime.Infinite, the device will remain in the list until explicitly removed or until the blackout list is reset Disconnect Command type Time, in 30 seconds increments, the client device will remain undiscoverable after disconnect has been requested. Set to 0 to disable. Application specific duration the client shall remain undiscoverable after disconnection

Disconnect from a remote device, without putting it in the blackout list Throws an exception if the library is in the wrong state or busy with another request

Request the connected remote device to switch to the specified radio frequency and channel period

New radio frequency New beacon period

Puts the device on a blackout list for a period of time. A device in the blackout list will not show up in any search results. A wildcard parameter (0) is not allowed for any of the device ID parameters. An exception is thrown if the device can not be added to the blackout list, either because the list is full, or the device ID is invalid

The device ID of a specific device The specific manufacturer ID The specific device type Number of seconds the device ID should remain on the blackout list. If set to BlackoutTime.None, the device is not put in a blackout list. If set to BlackoutTime.Infinite, the device will remain in the list until explicitly removed or until the blackout list is reset

Remove the device from the blackout list A wildcard parameter (0) is not allowed for any of the device ID parameters, and will result in returning False. Throws an exception if the device can not be removed from the list (e.g. device was not in list)

The device ID of a specific device The specific manufacturer ID The specific device type

Clears the blackout list

Enables ping message to be sent to the remote device periodically. This can be used to keep the remote device from timing out during operations that wait for user input.

Periodic ping enable Requests to pair with the connected remote device Throws an exception if the library is in the wrong state or busy with another request

Request to pair with the connected remote device Throws an exception if the library is in the wrong state or busy with another request

The type of authentication to execute on the remote device String to be used in conjunction with the particular authentication type (e.g. passkey) Number of miliseconds to wait for a response after the authenticate command is set

Request to pair with the connected remote device Throws an exception if the library is in the wrong state or busy with another request

The type of authentication to execute on the remote device String to be used in conjunction with the particular authentication type (e.g. friendly name) Number of miliseconds to wait for a response after the authenticate command is sent

Request to pair with the connected remote device, without specifying an authentication string Throws an exception if the library is in the wrong state or busy with another request

The type of authentication to execute on the remote device Number of miliseconds to wait for a response after the authenticate command is sent Request a download of a file from the authenticated device Throws an exception if the library is in the wrong state or busy with another request

Request a download of a file from the authenticated device Throws an exception if the library is in the wrong state or busy with another request

The file number to be downloaded Byte offset from where to begin transferring the data Maximum number of bytes to download. Set to zero (0) if the host does not wish to limit the total size of the download Maximum number of bytes to download in a single block. Set to zero (0) if the host does not wish to limit the block size

Request a download of a file from the authenticated device Throws an exception if the library is in the wrong state or busy with another request

Requests a download of the directory file from the authenticated device Throws an exception if the library is in the wrong state or busy with another request

Requests the erasure of a file on the authenticated remote device Throws an exception if the library is in the wrong state or busy with another request

The file number of the file to erase Requests an upload of a file to the authenticated device Throws an exception if the library is in the wrong state or busy with another request

Requests an upload of a file to the authenticated device Throws an exception if the library is in the wrong state or busy with another request

The file number to be uploaded The byte offset from where to begin transferring the data Buffer where data to be sent is stored Force the offset

Requests a new upload of a file to the authenticated device Throws an exception if the library is in the wrong state or busy with another request

The file number to be uploaded Buffer where data to be sent is stored

Retrieves the parameters of the most recently found device

Parameters of the most recently found device, or null if no parameters could be retrieved

Retrieves the channel ID of the most recently found device. An exception will be thrown if no device has been found

The Channel ID of the most recently found device.

Obtains the additional data received on an Authentication Response (e.g. PassKey), if available

Authentication response additional parameters, or an empty array if no additional parameters were received

Gets the transfer progress of a pending or complete download

The transfer status, including the current byte progress, total expected length of the download, and current percentage. Returns null if no valid status could be obtained.

Gets the transfer progress of a pending or complete upload

The transfer status, including the current byte progress, total expected length of the upload, and current percentage. Returns null if no valid status could be obtained.

Gets the received data from a transfer (download)

Buffer containing the downloaded data. Returns an empty buffer if no data is available or the download size is 0

Retrieves the size of a downloaded file

Download size (in bytes)

Returns the current library status

Current library status

Returns the current ANTFS state from the last seen ANTFS beacon of the connected device.

Ant-Fs State from last received beacon or BeaconNotFound if no device is connected

Gets the version string of the underlying ANT-FS library

ANT-FS Library Version String

Cancels any pending actions and returns the library to the appropiate ANT-FS layer if possible, i.e. if the library was executing a download command in the transport layer, the library would be returned to the Transport State. A response of CancelDone will be sent back to the application when the cancel operation is complete.

Processing of incoming ANT-FS responses

The ANT-FS host callback event, triggered every time a response is received from the ANT-FS host library

ANT-FS Responses

!!! Must match the enum in antfs_host_channel.hpp

ANT-FS State

!!! Must match the enum in antfs_host_channel.hpp

Beacon ANT-FS State

!!! Must match the defs in antfsmessage.h

Delegate for the DeviceNotification event

The notification code for the current event An object that optionally holds more information about the current event

Delegate for Channel Response Event for forwarding the raw msg struct. If you are coding in C# use the other response event version.

Message bytes received from device Length of data in message structure

Delegate for Channel Response Event

Message details received from device

The information for this version of the ANT Managed Library

This string shows the date the library received its current version number

Returns the version information as a string

Managed Library Version String

Gets the version string of the underlying unmanaged wrapper library, ANT_WrappedLib.dll

Unmanaged Wrapper Version String