Tsctl TCP API: Difference between revisions

From embeddedTS Manuals
No edit summary
Line 4: Line 4:
= Functions =
= Functions =
== ClassCount ==
== ClassCount ==
This functionality is described [[Tsctl API Reference#ClassCount|here]].
[[Tsctl API Reference#ClassCount|See ClassCount API Reference]].


{| class=wikitable
{| class=wikitable
Line 61: Line 61:
| ClassCount
| ClassCount
| ClassCount
| ClassCount
|-
|
|
|
|
!
| 8
| 1
| tag
| 0x80
|}
== InstanceCount ==
[[Tsctl API Reference#InstanceCount|See InstanceCount API Reference]].
{| class=wikitable
|-
! colspan=4 | TCP Request Packet
|
! colspan=4 | 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 ==
[[Tsctl API Reference#APICount|See APICount API Reference]].
{| class=wikitable
|-
! colspan=4 | TCP Request Packet
|
! colspan=4 | 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
| 0x2
!
| 3
| 1
| tag
| 0x13
|-
| 4
| 4
| ClassNumber
| ClassNumber
!
| 4
| 4
| APICount
| APICount
|-
|-
|  
|  

Revision as of 21:59, 13 February 2013

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 0x2 3 1 tag 0x13
4 4 ClassNumber ClassNumber 4 4 APICount APICount
8 1 tag 0x80
Retrieved from "http://docs.embeddedTS.com/index.php?title=Tsctl_TCP_API&oldid=3246"