Tsctl TCP API

From embeddedTS Manuals
Revision as of 23:49, 13 February 2013 by Mark (talk | contribs)

Overview

The tsctl server serves up a TCP api on port 5001. This includes all of the functionality available using the standard Tsctl API Reference.

Functions

ClassCount

See ClassCount API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 ClassCount ClassCount
8 1 tag 0x80

InstanceCount

See InstanceCount API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 ClassNumber ClassNumber 4 4 InstanceCount InstanceCount
8 1 tag 0x80

APICount

See APICount API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 ClassNumber ClassNumber 4 4 APICount APICount
8 1 tag 0x80

LockCount

See LockCount API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0x13
4 4 LockCount LockCount
8 1 tag 0x80

LockHolderInfo

See LockHolderInfo API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x70
4 4 LockHolderInfo.Length LockHolderInfo.Length
8+i*10 1 tag 0x13
9+i*10 4 LockHolderInfo[i].pid LockHolderInfo[i].pid
13+i*10 1 tag 0x13
14+i*10 4 LockHolderInfo[i].count LockHolderInfo[i].count
18+i*10 1 tag 0x80

ConnWaitInfo

See ConnWaitInfo API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0x70
4 4 ConnWaitInfo.Length ConnWaitInfo.Length
8+i*10 1 tag 0x13
9+i*10 4 ConnWaitInfo[i].pid ConnWaitInfo[i].pid
13+i*10 1 tag 0x13
14+i*10 4 ConnWaitInfo[i].wait ConnWaitInfo[i].wait
18+i*10 1 tag 0x80

CANBusGet

See CANBusGet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0xC0
4 4 CANInstance CANInstance 4 4 CANBusGet CANBusGet
8 1 tag 0x80

BuildTime

See BuildTime API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x07
3 1 command 0x07 3 1 tag 0x03
4 4 BuildTime BuildTime
8 1 tag 0x80

ModelId

See ModelId API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x08
3 1 command 0x08 3 1 tag 0x13
4 4 ModelId ModelId
8 1 tag 0x80

BaseBoardId

See BaseBoardId API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x09
3 1 command 0x09 3 1 tag 0x13
4 4 BaseBoardId BaseBoardId
8 1 tag 0x80

MapLength

See MapLength API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x0A
3 1 command 0x0A 3 1 tag 0x13
4 4 MapLength MapLength
8 1 tag 0x80

MapGet

See MapGet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x0B
3 1 command 0x0B 3 1 tag 0x50
4 4 MapIndex MapIndex 4 4 MapGet.Length MapGet.Length
8 1*MapGet.Length MapGet MapGet
8+1*MapGet.Length 1 tag 0x53
9+1*MapGet.Length 4 Value.Length Value.Length
13+1*MapGet.Length 4*Value.Length Value Value
13+1*MapGet.Length+4*Value.Length 1 tag 0x80

MapLookup

See MapLookup API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x0C
3 1 command 0x0C 3 1 tag 0x13
4 4 String.Length String.Length 4 4 MapLookup MapLookup
8 1*String.Length String String 8 1 tag 0x80

MapLookupPartial

See MapLookupPartial API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x0D
3 1 command 0x0D 3 1 tag 0x50
4 4 StringPrefix.Length StringPrefix.Length 4 4 MapLookupPartial.Length MapLookupPartial.Length
8 1*StringPrefix.Length StringPrefix StringPrefix 8 1*MapLookupPartial.Length MapLookupPartial MapLookupPartial
8+1*StringPrefix.Length 4 Value Value 8+1*MapLookupPartial.Length 1 tag 0x80

MapAdd

See MapAdd API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x0E
3 1 command 0x0E 3 1 tag 0xC0
4 4 String.Length String.Length 4 4 MapAdd MapAdd
8 1*String.Length String String 8 1 tag 0x80
8+1*String.Length 4 Value Value

MapDelete

See MapDelete API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x0F
3 1 command 0x0F 3 1 tag 0xC0
4 4 String.Length String.Length 4 4 MapDelete MapDelete
8 1*String.Length String String 8 1 tag 0x80

Note

See Note API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x10
3 1 command 0x10 3 1 tag 0x50
4 4 Message.Length Message.Length 4 4 Note.Length Note.Length
8 1*Message.Length Message Message 8 1*Note.Length Note Note
8+1*Note.Length 1 tag 0x80

Version

See Version API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x11
3 1 command 0x11 3 1 tag 0x50
4 4 Version.Length Version.Length
8 1*Version.Length Version Version
8+1*Version.Length 1 tag 0x80

UptimeServer

See UptimeServer API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x12
3 1 command 0x12 3 1 tag 0x03
4 4 UptimeServer UptimeServer
8 1 tag 0x80

UptimeHost

See UptimeHost API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x13
3 1 command 0x13 3 1 tag 0x03
4 4 UptimeHost UptimeHost
8 1 tag 0x80

FPGARevision

See FPGARevision API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x14
3 1 command 0x14 3 1 tag 0x13
4 4 FPGARevision FPGARevision
8 1 tag 0x80

EchoNumber

See EchoNumber API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0000 0 2 class 0x0000
2 1 instance instance 2 1 command 0x15
3 1 command 0x15 3 1 tag 0x13
4 4 n n 4 4 EchoNumber EchoNumber
8 1 tag 0x80

Lock

See Lock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 num num 4 4 Lock Lock
8 4 flags flags 8 1 tag 0x80

Unlock

See Unlock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 num num 4 4 Unlock Unlock
8 4 flags flags 8 1 tag 0x80

Preempt

See Preempt API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 Preempt Preempt
8 1 tag 0x80

Peek8

See Peek8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0x00
4 4 Address Address 4 1 Peek8 Peek8
5 1 tag 0x80

Poke8

See Poke8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x80
4 4 Address Address
8 1 Value Value

Peek16

See Peek16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0x01
4 4 Address Address 4 2 Peek16 Peek16
6 1 tag 0x80

Poke16

See Poke16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0x80
4 4 Address Address
8 2 Value Value

Peek32

See Peek32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x07
3 1 command 0x07 3 1 tag 0x03
4 4 Address Address 4 4 Peek32 Peek32
8 1 tag 0x80

Poke32

See Poke32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x08
3 1 command 0x08 3 1 tag 0x80
4 4 Address Address
8 4 Value Value

BitGet8

See BitGet8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x09
3 1 command 0x09 3 1 tag 0x13
4 4 Address Address 4 4 BitGet8 BitGet8
8 4 BitNumber BitNumber 8 1 tag 0x80

BitAssign8

See BitAssign8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x0A
3 1 command 0x0A 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber
12 4 Value Value

BitSet8

See BitSet8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x0B
3 1 command 0x0B 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber

BitClear8

See BitClear8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x0C
3 1 command 0x0C 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber

BitGet16

See BitGet16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x0D
3 1 command 0x0D 3 1 tag 0x13
4 4 Address Address 4 4 BitGet16 BitGet16
8 4 BitNumber BitNumber 8 1 tag 0x80

BitAssign16

See BitAssign16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x0E
3 1 command 0x0E 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber
12 4 Value Value

BitSet16

See BitSet16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x0F
3 1 command 0x0F 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber

BitClear16

See BitClear16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x10
3 1 command 0x10 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber

BitGet32

See BitGet32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x11
3 1 command 0x11 3 1 tag 0x13
4 4 Address Address 4 4 BitGet32 BitGet32
8 4 BitNumber BitNumber 8 1 tag 0x80

BitAssign32

See BitAssign32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x12
3 1 command 0x12 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber
12 4 Value Value

BitSet32

See BitSet32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x13
3 1 command 0x13 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber

BitClear32

See BitClear32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x14
3 1 command 0x14 3 1 tag 0x80
4 4 Address Address
8 4 BitNumber BitNumber

PeekStream

See PeekStream API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x15
3 1 command 0x15 3 1 tag 0x50
4 4 address address 4 4 dest.Length dest.Length
8 4 direction direction 8 1*dest.Length dest dest
12 4 dest.Length dest.Length 8+1*dest.Length 1 tag 0x80

PokeStream

See PokeStream API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x16
3 1 command 0x16 3 1 tag 0x80
4 4 address address
8 4 direction direction
12 4 data.Length data.Length
16 1*data.Length data data

Refresh

See Refresh API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x17
3 1 command 0x17 3 1 tag 0x80

Commit

See Commit API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x18
3 1 command 0x18 3 1 tag 0x80
4 4 ForceAll ForceAll

BitToggle8

See BitToggle8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x19
3 1 command 0x19 3 1 tag 0x13
4 4 Address Address 4 4 BitToggle8 BitToggle8
8 4 BitNumber BitNumber 8 1 tag 0x80

BitToggle16

See BitToggle16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x1A
3 1 command 0x1A 3 1 tag 0x13
4 4 Address Address 4 4 BitToggle16 BitToggle16
8 4 BitNumber BitNumber 8 1 tag 0x80

BitToggle32

See BitToggle32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x1B
3 1 command 0x1B 3 1 tag 0x13
4 4 Address Address 4 4 BitToggle32 BitToggle32
8 4 BitNumber BitNumber 8 1 tag 0x80

Assign8X

See Assign8X API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x1C
3 1 command 0x1C 3 1 tag 0x00
4 4 Address Address 4 1 Assign8X Assign8X
8 4 BitMSB BitMSB 5 1 tag 0x80
12 4 BitLSB BitLSB
16 4 Value Value

Assign16X

See Assign16X API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x1D
3 1 command 0x1D 3 1 tag 0x01
4 4 Address Address 4 2 Assign16X Assign16X
8 4 BitMSB BitMSB 6 1 tag 0x80
12 4 BitLSB BitLSB
16 4 Value Value

Assign32X

See Assign32X API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x1E
3 1 command 0x1E 3 1 tag 0x03
4 4 Address Address 4 4 Assign32X Assign32X
8 4 BitMSB BitMSB 8 1 tag 0x80
12 4 BitLSB BitLSB
16 4 Value Value

BitsGet8

See BitsGet8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x1F
3 1 command 0x1F 3 1 tag 0x00
4 4 Address Address 4 1 BitsGet8 BitsGet8
8 4 BitMSB BitMSB 5 1 tag 0x80
12 4 BitLSB BitLSB

BitsGet16

See BitsGet16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x20
3 1 command 0x20 3 1 tag 0x01
4 4 Address Address 4 2 BitsGet16 BitsGet16
8 4 BitMSB BitMSB 6 1 tag 0x80
12 4 BitLSB BitLSB

BitsGet32

See BitsGet32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0001 0 2 class 0x0001
2 1 instance instance 2 1 command 0x21
3 1 command 0x21 3 1 tag 0x03
4 4 Address Address 4 4 BitsGet32 BitsGet32
8 4 BitMSB BitMSB 8 1 tag 0x80
12 4 BitLSB BitLSB

Wait

See Wait API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0002 0 2 class 0x0002
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x03
4 4 microseconds microseconds 4 4 Wait Wait
8 1 tag 0x80

Delay

See Delay API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0002 0 2 class 0x0002
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x80
4 4 microseconds microseconds

Tick

See Tick API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0002 0 2 class 0x0002
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x03
4 4 Tick Tick
8 1 tag 0x80

usElapsed

See usElapsed API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0002 0 2 class 0x0002
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0x03
4 4 start start 4 4 usElapsed usElapsed
8 1 tag 0x80

usFuture

See usFuture API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0002 0 2 class 0x0002
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x03
4 4 start start 4 4 usFuture usFuture
8 4 microseconds microseconds 8 1 tag 0x80

TimeoutQ

See TimeoutQ API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0002 0 2 class 0x0002
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0xC1
4 4 start start 4 4 TimeoutQ TimeoutQ
8 4 end end 8 1 tag 0x80

TPS

See TPS API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0002 0 2 class 0x0002
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0x03
4 4 TPS TPS
8 1 tag 0x80

Lock

See Lock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0003 0 2 class 0x0003
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 num num 4 4 Lock Lock
8 4 flags flags 8 1 tag 0x80

Unlock

See Unlock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0003 0 2 class 0x0003
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 num num 4 4 Unlock Unlock
8 4 flags flags 8 1 tag 0x80

Preempt

See Preempt API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0003 0 2 class 0x0003
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 Preempt Preempt
8 1 tag 0x80

ModeGet

See ModeGet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0003 0 2 class 0x0003
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0xC2
4 4 PinNumber PinNumber 4 4 ModeGet ModeGet
8 1 tag 0x80

ModeSet

See ModeSet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0003 0 2 class 0x0003
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0xC3
4 4 PinNumber PinNumber 4 4 ModeSet ModeSet
8 4 Mode Mode 8 1 tag 0x80

Lock

See Lock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0004 0 2 class 0x0004
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 num num 4 4 Lock Lock
8 4 flags flags 8 1 tag 0x80

Unlock

See Unlock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0004 0 2 class 0x0004
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 num num 4 4 Unlock Unlock
8 4 flags flags 8 1 tag 0x80

Preempt

See Preempt API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0004 0 2 class 0x0004
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 Preempt Preempt
8 1 tag 0x80

DirSet

See DirSet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0004 0 2 class 0x0004
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0x80
4 4 num num
8 4 asOutput asOutput

DataSet

See DataSet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0004 0 2 class 0x0004
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x80
4 4 num num
8 4 asHigh asHigh

DirGet

See DirGet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0004 0 2 class 0x0004
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0x13
4 4 num num 4 4 DirGet DirGet
8 1 tag 0x80

DataGet

See DataGet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0004 0 2 class 0x0004
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0x13
4 4 num num 4 4 DataGet DataGet
8 1 tag 0x80

Count

See Count API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0004 0 2 class 0x0004
2 1 instance instance 2 1 command 0x07
3 1 command 0x07 3 1 tag 0x03
4 4 Count Count
8 1 tag 0x80

Lock

See Lock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 num num 4 4 Lock Lock
8 4 flags flags 8 1 tag 0x80

Unlock

See Unlock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 num num 4 4 Unlock Unlock
8 4 flags flags 8 1 tag 0x80

Preempt

See Preempt API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 Preempt Preempt
8 1 tag 0x80

Refresh

See Refresh API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0x80

Commit

See Commit API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x80
4 4 ForceAll ForceAll

Set

See Set API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0x80
4 4 DIONum DIONum
8 4 State State

Get

See Get API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0xC4
4 4 DIONum DIONum 4 4 Get Get
8 1 tag 0x80

SetAsync

See SetAsync API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x07
3 1 command 0x07 3 1 tag 0x80
4 4 DIONum DIONum
8 4 State State

GetAsync

See GetAsync API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x08
3 1 command 0x08 3 1 tag 0xC4
4 4 DIONum DIONum 4 4 GetAsync GetAsync
8 1 tag 0x80

Wait

See Wait API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x09
3 1 command 0x09 3 1 tag 0x53
4 4 match.Length match.Length 4 4 match.Length match.Length
8 4 min min 8 4*match.Length match match
12 4 max max 8+4*match.Length 1 tag 0x80
16 4 nh.Length nh.Length
20 4*nh.Length nh nh
20+4*nh.Length 4 nl.Length nl.Length
24+4*nh.Length 4*nl.Length nl nl

Count

See Count API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x0A
3 1 command 0x0A 3 1 tag 0x03
4 4 Count Count
8 1 tag 0x80

Capabilities

See Capabilities API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x0B
3 1 command 0x0B 3 1 tag 0xC5
4 4 num num 4 4 Capabilities Capabilities
8 1 tag 0x80

GetMulti

See GetMulti API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0005 0 2 class 0x0005
2 1 instance instance 2 1 command 0x0C
3 1 command 0x0C 3 1 tag 0x13
4 4 state.Length state.Length 4 4 GetMulti GetMulti
8 4 offset offset 8 1 tag 0x50
9 4 state.Length state.Length
13 1*state.Length state state
13+1*state.Length 1 tag 0x80

Lock

See Lock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0006 0 2 class 0x0006
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 num num 4 4 Lock Lock
8 4 flags flags 8 1 tag 0x80

Unlock

See Unlock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0006 0 2 class 0x0006
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 num num 4 4 Unlock Unlock
8 4 flags flags 8 1 tag 0x80

Preempt

See Preempt API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0006 0 2 class 0x0006
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 Preempt Preempt
8 1 tag 0x80

Write

See Write API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0006 0 2 class 0x0006
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0xC7
4 4 devadr devadr 4 4 Write Write
8 4 adrslen adrslen 8 1 tag 0x80
12 4 adrs adrs
16 4 bytes.Length bytes.Length
20 1*bytes.Length bytes bytes

Read

See Read API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0006 0 2 class 0x0006
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0xC7
4 4 devadr devadr 4 4 Read Read
8 4 adrslen adrslen 8 1 tag 0x50
12 4 adrs adrs 9 4 bytes.Length bytes.Length
16 4 bytes.Length bytes.Length 13 1*bytes.Length bytes bytes
13+1*bytes.Length 1 tag 0x80

Rx

See Rx API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0007 0 2 class 0x0007
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0xCB
4 4 Rx Rx
8 1 tag 0x74
9 4 arg1.Length 1
13+i*34 1 tag 0x03
14+i*34 4 arg1[i].flags arg1[i].flags
18+i*34 1 tag 0x03
19+i*34 4 arg1[i].id arg1[i].id
23+i*34 1 tag 0x03
24+i*34 4 arg1[i].t_sec arg1[i].t_sec
28+i*34 1 tag 0x03
29+i*34 4 arg1[i].t_usec arg1[i].t_usec
33+i*34 1 tag 0x03
34+i*34 4 arg1[i].length arg1[i].length
38+i*34 1 tag 0x40
39+i*34 4 arg1[i].data.Length arg1[i].data.Length
43+i*34 1*arg1[i].data.Length arg1[i].data arg1[i].data
43+i*34+1*arg1[i].data.Length 1 tag 0x80

Tx

See Tx API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0007 0 2 class 0x0007
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0xCB
4 4 flags flags 4 4 Tx Tx
8 4 id id 8 1 tag 0x80
12 4 data.Length data.Length
16 1*data.Length data data

BaudSet

See BaudSet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0007 0 2 class 0x0007
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x03
4 4 opt_baud opt_baud 4 4 BaudSet BaudSet
8 1 tag 0x80

BaudGet

See BaudGet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0007 0 2 class 0x0007
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0x03
4 4 BaudGet BaudGet
8 1 tag 0x80

Abort

See Abort API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0007 0 2 class 0x0007
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x80

RxMulti

See RxMulti API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0007 0 2 class 0x0007
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0xCB
4 4 msg.Length msg.Length 4 4 RxMulti RxMulti
8 4 min min 8 1 tag 0x74
9 4 arg1.Length arg1.Length
13+i*34 1 tag 0x03
14+i*34 4 arg1[i].flags arg1[i].flags
18+i*34 1 tag 0x03
19+i*34 4 arg1[i].id arg1[i].id
23+i*34 1 tag 0x03
24+i*34 4 arg1[i].t_sec arg1[i].t_sec
28+i*34 1 tag 0x03
29+i*34 4 arg1[i].t_usec arg1[i].t_usec
33+i*34 1 tag 0x03
34+i*34 4 arg1[i].length arg1[i].length
38+i*34 1 tag 0x40
39+i*34 4 arg1[i].data.Length arg1[i].data.Length
43+i*34 1*arg1[i].data.Length arg1[i].data arg1[i].data
43+i*34+1*arg1[i].data.Length 1 tag 0x80

Lock

See Lock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0008 0 2 class 0x0008
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 num num 4 4 Lock Lock
8 4 flags flags 8 1 tag 0x80

Unlock

See Unlock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0008 0 2 class 0x0008
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 num num 4 4 Unlock Unlock
8 4 flags flags 8 1 tag 0x80

Preempt

See Preempt API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0008 0 2 class 0x0008
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 Preempt Preempt
8 1 tag 0x80

Write

See Write API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0008 0 2 class 0x0008
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0xCC
4 4 adrs adrs 4 4 Write Write
8 4 buf.Length buf.Length 8 1 tag 0x80
12 1*buf.Length buf buf

Read

See Read API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0008 0 2 class 0x0008
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0xCC
4 4 adrs adrs 4 4 Read Read
8 4 buf.Length buf.Length 8 1 tag 0x40
9 4 buf.Length buf.Length
13 1*buf.Length buf buf
13+1*buf.Length 1 tag 0x80

ReadWrite

See ReadWrite API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0008 0 2 class 0x0008
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0xCC
4 4 adrs adrs 4 4 ReadWrite ReadWrite
8 4 wbuf.Length wbuf.Length 8 1 tag 0x40
12 1*wbuf.Length wbuf wbuf 9 4 rbuf.Length rbuf.Length
12+1*wbuf.Length 4 rbuf.Length rbuf.Length 13 1*rbuf.Length rbuf rbuf
13+1*rbuf.Length 1 tag 0x80

ClockSet

See ClockSet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0008 0 2 class 0x0008
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0xCC
4 4 hz hz 4 4 ClockSet ClockSet
8 1 tag 0x80

EdgeSet

See EdgeSet API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0008 0 2 class 0x0008
2 1 instance instance 2 1 command 0x07
3 1 command 0x07 3 1 tag 0xCC
4 4 posedge posedge 4 4 EdgeSet EdgeSet
8 1 tag 0x80

Lock

See Lock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 num num 4 4 Lock Lock
8 4 flags flags 8 1 tag 0x80

Unlock

See Unlock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 num num 4 4 Unlock Unlock
8 4 flags flags 8 1 tag 0x80

Preempt

See Preempt API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 Preempt Preempt
8 1 tag 0x80

Type

See Type API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0xCD
4 4 Type Type
8 1 tag 0x80

VoltageRangeList

See VoltageRangeList API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x70
4 4 VoltageRangeList.Length VoltageRangeList.Length
8+i*32 1 tag 0x31
9+i*32 1 tag 0x23
10+i*32 4 VoltageRangeList[i].low.start VoltageRangeList[i].low.start
14+i*32 1 tag 0x23
15+i*32 4 VoltageRangeList[i].low.step VoltageRangeList[i].low.step
19+i*32 1 tag 0x03
20+i*32 4 VoltageRangeList[i].low.count VoltageRangeList[i].low.count
24+i*32 1 tag 0x31
25+i*32 1 tag 0x23
26+i*32 4 VoltageRangeList[i].high.start VoltageRangeList[i].high.start
30+i*32 1 tag 0x23
31+i*32 4 VoltageRangeList[i].high.step VoltageRangeList[i].high.step
35+i*32 1 tag 0x03
36+i*32 4 VoltageRangeList[i].high.count VoltageRangeList[i].high.count
40+i*32 1 tag 0x80

PrecisionList

See PrecisionList API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0x13
4 4 PrecisionList PrecisionList
8 1 tag 0x80

PeriodRangeList

See PeriodRangeList API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0x71
4 4 PeriodRangeList.Length PeriodRangeList.Length
8+i*15 1 tag 0x03
9+i*15 4 PeriodRangeList[i].start PeriodRangeList[i].start
13+i*15 1 tag 0x03
14+i*15 4 PeriodRangeList[i].step PeriodRangeList[i].step
18+i*15 1 tag 0x03
19+i*15 4 PeriodRangeList[i].count PeriodRangeList[i].count
23+i*15 1 tag 0x80

TriggerList

See TriggerList API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x07
3 1 command 0x07 3 1 tag 0x53
4 4 TriggerList.Length TriggerList.Length
8 4*TriggerList.Length TriggerList TriggerList
8+4*TriggerList.Length 1 tag 0x80

Channels

See Channels API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x08
3 1 command 0x08 3 1 tag 0x13
4 4 Channels Channels
8 1 tag 0x80

Reset

See Reset API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x09
3 1 command 0x09 3 1 tag 0x80

ChannelEnable

See ChannelEnable API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x0A
3 1 command 0x0A 3 1 tag 0x13
4 4 ch ch 4 4 ChannelEnable ChannelEnable
8 4 flag flag 8 1 tag 0x80

ChannelSamplePeriod

See ChannelSamplePeriod API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x0B
3 1 command 0x0B 3 1 tag 0x03
4 4 ch ch 4 4 ChannelSamplePeriod ChannelSamplePeriod
8 4 ns ns 8 1 tag 0x80

ChannelPrecision

See ChannelPrecision API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x0C
3 1 command 0x0C 3 1 tag 0x13
4 4 ch ch 4 4 ChannelPrecision ChannelPrecision
8 4 prec prec 8 1 tag 0x80

ChannelVoltageRange

See ChannelVoltageRange API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x0D
3 1 command 0x0D 3 1 tag 0x13
4 4 ch ch 4 4 ChannelVoltageRange ChannelVoltageRange
8 4 low low 8 1 tag 0x80
12 4 high high

Configuration

See Configuration API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x0E
3 1 command 0x0E 3 1 tag 0x13
4 4 low.Length low.Length 4 4 Configuration Configuration
8 4 high.Length high.Length 8 1 tag 0x63
12 4 prec.Length prec.Length 9 4 low.Length low.Length
16 4 t.Length t.Length 13 4*low.Length low low
20 4 trigger.Length trigger.Length 13+4*low.Length 1 tag 0x63
14+4*low.Length 4 high.Length high.Length
18+4*low.Length 4*high.Length high high
18+4*low.Length+4*high.Length 1 tag 0x53
19+4*low.Length+4*high.Length 4 prec.Length prec.Length
23+4*low.Length+4*high.Length 4*prec.Length prec prec
23+4*low.Length+4*high.Length+4*prec.Length 1 tag 0x53
24+4*low.Length+4*high.Length+4*prec.Length 4 t.Length t.Length
28+4*low.Length+4*high.Length+4*prec.Length 4*t.Length t t
28+4*low.Length+4*high.Length+4*prec.Length+4*t.Length 1 tag 0x53
29+4*low.Length+4*high.Length+4*prec.Length+4*t.Length 4 trigger.Length trigger.Length
33+4*low.Length+4*high.Length+4*prec.Length+4*t.Length 4*trigger.Length trigger trigger
33+4*low.Length+4*high.Length+4*prec.Length+4*t.Length+4*trigger.Length 1 tag 0x53
34+4*low.Length+4*high.Length+4*prec.Length+4*t.Length+4*trigger.Length 4 itrig.Length itrig.Length
38+4*low.Length+4*high.Length+4*prec.Length+4*t.Length+4*trigger.Length 4*itrig.Length itrig itrig
38+4*low.Length+4*high.Length+4*prec.Length+4*t.Length+4*trigger.Length+4*itrig.Length 1 tag 0x80

ConfigureTest

See ConfigureTest API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x0F
3 1 command 0x0F 3 1 tag 0x13
4 4 low.Length low.Length 4 4 ConfigureTest ConfigureTest
8 4*low.Length low low 8 1 tag 0x80
8+4*low.Length 4 high.Length high.Length
12+4*low.Length 4*high.Length high high
12+4*low.Length+4*high.Length 4 prec.Length prec.Length
16+4*low.Length+4*high.Length 4*prec.Length prec prec
16+4*low.Length+4*high.Length+4*prec.Length 4 rate.Length rate.Length
20+4*low.Length+4*high.Length+4*prec.Length 4*rate.Length rate rate
20+4*low.Length+4*high.Length+4*prec.Length+4*rate.Length 4 trigger.Length trigger.Length
24+4*low.Length+4*high.Length+4*prec.Length+4*rate.Length 4*trigger.Length trigger trigger
24+4*low.Length+4*high.Length+4*prec.Length+4*rate.Length+4*trigger.Length 4 itrig itrig

Configure

See Configure API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x10
3 1 command 0x10 3 1 tag 0x13
4 4 low.Length low.Length 4 4 Configure Configure
8 4*low.Length low low 8 1 tag 0x80
8+4*low.Length 4 high.Length high.Length
12+4*low.Length 4*high.Length high high
12+4*low.Length+4*high.Length 4 prec.Length prec.Length
16+4*low.Length+4*high.Length 4*prec.Length prec prec
16+4*low.Length+4*high.Length+4*prec.Length 4 rate.Length rate.Length
20+4*low.Length+4*high.Length+4*prec.Length 4*rate.Length rate rate
20+4*low.Length+4*high.Length+4*prec.Length+4*rate.Length 4 trigger.Length trigger.Length
24+4*low.Length+4*high.Length+4*prec.Length+4*rate.Length 4*trigger.Length trigger trigger
24+4*low.Length+4*high.Length+4*prec.Length+4*rate.Length+4*trigger.Length 4 itrig itrig

ITrig

See ITrig API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x11
3 1 command 0x11 3 1 tag 0x13
4 4 itrig itrig 4 4 ITrig ITrig
8 1 tag 0x80

Get

See Get API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x12
3 1 command 0x12 3 1 tag 0x13
4 4 channel channel 4 4 Get Get
8 1 tag 0x80

Put

See Put API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x13
3 1 command 0x13 3 1 tag 0x13
4 4 channel channel 4 4 Put Put
8 4 value value 8 1 tag 0x80

Ready

See Ready API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x14
3 1 command 0x14 3 1 tag 0x13
4 4 channel channel 4 4 Ready Ready
8 1 tag 0x80

Gets8

See Gets8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x15
3 1 command 0x15 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Gets8 Gets8
8 1 tag 0x50
9 4 buf.Length buf.Length
13 1*buf.Length buf buf
13+1*buf.Length 1 tag 0x80

Gets16

See Gets16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x16
3 1 command 0x16 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Gets16 Gets16
8 1 tag 0x51
9 4 buf.Length buf.Length
13 2*buf.Length buf buf
13+2*buf.Length 1 tag 0x80

Gets32

See Gets32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x17
3 1 command 0x17 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Gets32 Gets32
8 1 tag 0x53
9 4 buf.Length buf.Length
13 4*buf.Length buf buf
13+4*buf.Length 1 tag 0x80

Puts8

See Puts8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x18
3 1 command 0x18 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Puts8 Puts8
8 1*buf.Length buf buf 8 1 tag 0x80

Puts16

See Puts16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x19
3 1 command 0x19 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Puts16 Puts16
8 2*buf.Length buf buf 8 1 tag 0x80

Puts32

See Puts32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x1A
3 1 command 0x1A 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Puts32 Puts32
8 4*buf.Length buf buf 8 1 tag 0x80

Readys8

See Readys8 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x1B
3 1 command 0x1B 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Readys8 Readys8
8 1*buf.Length buf buf 8 1 tag 0x80

Readys16

See Readys16 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x1C
3 1 command 0x1C 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Readys16 Readys16
8 2*buf.Length buf buf 8 1 tag 0x80

Readys32

See Readys32 API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x0009 0 2 class 0x0009
2 1 instance instance 2 1 command 0x1D
3 1 command 0x1D 3 1 tag 0x13
4 4 buf.Length buf.Length 4 4 Readys32 Readys32
8 4*buf.Length buf buf 8 1 tag 0x80

Lock

See Lock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x13
4 4 num num 4 4 Lock Lock
8 4 flags flags 8 1 tag 0x80

Unlock

See Unlock API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x13
4 4 num num 4 4 Unlock Unlock
8 4 flags flags 8 1 tag 0x80

Preempt

See Preempt API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x13
4 4 Preempt Preempt
8 1 tag 0x80

QueryFunction

See QueryFunction API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0x53
4 4 type type 4 4 QueryFunction.Length QueryFunction.Length
8 4*QueryFunction.Length QueryFunction QueryFunction
8+4*QueryFunction.Length 1 tag 0x80

PWM

See PWM API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x13
4 4 num num 4 4 PWM PWM
8 4 periodHigh periodHigh 8 1 tag 0x80
12 4 periodLow periodLow

QueryPWM

See QueryPWM API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0x13
4 4 num num 4 4 QueryPWM QueryPWM
8 1 tag 0x43
9 4 periodHigh.Length periodHigh.Length
13 4*periodHigh.Length periodHigh periodHigh
13+4*periodHigh.Length 1 tag 0x43
14+4*periodHigh.Length 4 periodLow.Length periodLow.Length
18+4*periodHigh.Length 4*periodLow.Length periodLow periodLow
18+4*periodHigh.Length+4*periodLow.Length 1 tag 0x80

PWMfd

See PWMfd API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0x13
4 4 num num 4 4 PWMfd PWMfd
8 4 freq freq 8 1 tag 0x80
12 4 DC DC

QueryPWMfd

See QueryPWMfd API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x07
3 1 command 0x07 3 1 tag 0x13
4 4 num num 4 4 QueryPWMfd QueryPWMfd
8 1 tag 0x43
9 4 freq.Length freq.Length
13 4*freq.Length freq freq
13+4*freq.Length 1 tag 0x43
14+4*freq.Length 4 DC.Length DC.Length
18+4*freq.Length 4*DC.Length DC DC
18+4*freq.Length+4*DC.Length 1 tag 0x80

QuadratureCount

See QuadratureCount API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x08
3 1 command 0x08 3 1 tag 0x13
4 4 num num 4 4 QuadratureCount QuadratureCount
8 1 tag 0x80

EdgeCount

See EdgeCount API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x09
3 1 command 0x09 3 1 tag 0x03
4 4 num num 4 4 EdgeCount EdgeCount
8 4 edge edge 8 1 tag 0x80

Glitched

See Glitched API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x0A
3 1 command 0x0A 3 1 tag 0x13
4 4 num num 4 4 Glitched Glitched
8 1 tag 0x80

HBridge

See HBridge API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000A 0 2 class 0x000A
2 1 instance instance 2 1 command 0x0B
3 1 command 0x0B 3 1 tag 0x13
4 4 num num 4 4 HBridge HBridge
8 4 state state 8 1 tag 0x80

JSON

See JSON API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x00
3 1 command 0x00 3 1 tag 0x80

Assign

See Assign API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x01
3 1 command 0x01 3 1 tag 0x80

NoAssign

See NoAssign API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x02
3 1 command 0x02 3 1 tag 0x80

Hex

See Hex API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x03
3 1 command 0x03 3 1 tag 0x80

Dec

See Dec API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x04
3 1 command 0x04 3 1 tag 0x80

Oct

See Oct API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x05
3 1 command 0x05 3 1 tag 0x80

AStr

See AStr API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x06
3 1 command 0x06 3 1 tag 0x80

AHex

See AHex API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x07
3 1 command 0x07 3 1 tag 0x80

ADec

See ADec API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x08
3 1 command 0x08 3 1 tag 0x80

AOct

See AOct API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x09
3 1 command 0x09 3 1 tag 0x80

ABinOct

See ABinOct API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x0A
3 1 command 0x0A 3 1 tag 0x80

ABinHex

See ABinHex API Reference.

TCP Request Packet TCP Reply Packet
Offset Bytes Field Value Offset Bytes Field Value
0 2 class 0x000B 0 2 class 0x000B
2 1 instance instance 2 1 command 0x0B
3 1 command 0x0B 3 1 tag 0x80
Retrieved from "http://docs.embeddedTS.com/index.php?title=Tsctl_TCP_API&oldid=3247"