AntDeviceRequestDataPageT Method

Requests the data page.

Definition

Namespace: SmallEarthTech.AntPlus
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 4.0.0.0+4009252dff1e4f6bcda36b6b0041486552134bc5

public Task<MessagingReturnCode> RequestDataPage<T>(
	T page,
	uint ackWaitTime = 500,
	byte descriptor1 = 255,
	byte descriptor2 = 255,
	byte transmissionResponse = 4,
	CommandType commandType = CommandType.DataPage,
	ushort slaveSerialNumber = 65535
)
where T : Enum

Public Function RequestDataPage(Of T As Enum) ( 
	page As T,
	Optional ackWaitTime As UInteger = 500,
	Optional descriptor1 As Byte = 255,
	Optional descriptor2 As Byte = 255,
	Optional transmissionResponse As Byte = 4,
	Optional commandType As CommandType = CommandType.DataPage,
	Optional slaveSerialNumber As UShort = 65535
) As Task(Of MessagingReturnCode)

C++

public:
generic<typename T>
where T : Enum
Task<MessagingReturnCode>^ RequestDataPage(
	T page, 
	unsigned int ackWaitTime = 500, 
	unsigned char descriptor1 = 255, 
	unsigned char descriptor2 = 255, 
	unsigned char transmissionResponse = 4, 
	CommandType commandType = CommandType::DataPage, 
	unsigned short slaveSerialNumber = 65535
)

member RequestDataPage : 
        page : 'T * 
        ?ackWaitTime : uint32 * 
        ?descriptor1 : byte * 
        ?descriptor2 : byte * 
        ?transmissionResponse : byte * 
        ?commandType : CommandType * 
        ?slaveSerialNumber : uint16 
(* Defaults:
        let _ackWaitTime = defaultArg ackWaitTime 500
        let _descriptor1 = defaultArg descriptor1 255
        let _descriptor2 = defaultArg descriptor2 255
        let _transmissionResponse = defaultArg transmissionResponse 4
        let _commandType = defaultArg commandType CommandType.DataPage
        let _slaveSerialNumber = defaultArg slaveSerialNumber 65535
*)
-> Task<MessagingReturnCode>  when 'T : Enum

Parameters

page T: The requested page.
ackWaitTime UInt32 (Optional): Time in milliseconds to wait for the device acknowledgment. The default is 500ms.
descriptor1 Byte (Optional): The descriptor1. The default is 0xFF.
descriptor2 Byte (Optional): The descriptor2. The default is 0xFF.
transmissionResponse Byte (Optional): The transmission response. The default is to send 4 messages.
commandType CommandType (Optional): Type of the command. The default is DataPage.
slaveSerialNumber UInt16 (Optional): The slave serial number. The default is 0xFFFF.

Type Parameters

T: The data page enumeration of the derived ANT device class.

Return Value

TaskMessagingReturnCode
Status of the request.

Exceptions

ArgumentException

Invalid data page requested.