This page deals with the ICD-001 Track Filter Command.
<!--MsgId is the unique id of the message being sent --> <!--UserId is the numeric user id of the entity which requires to be updated --> <!--This command will enable the area with UserId 1 --> <?xml version="1.0" encoding="utf-8"?> <TrackFilterCommand xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" MsgId="0" MsgTimeStamp="0001-01-01T00:00:00" UniqueId="fb55785b-d087-4cbf-bcd5-8bff047ebdac" Latitude1="51.591427" Longitude1="-1.384499" Latitude2="51.59081" Longitude2="-1.381755" xmlns="ICDNAV001-TrackFilterCommand"> <Sender SenderId="SenderId1" NetworkAddress="127.0.0.1" NetworkPort="10000" /> </TrackFilterCommand > |
The track filter command provides the ability to change the area from which tracks are reported. By default ClearWay does NOT distribute tracks, this filter allows a customer to send through a geographical box to filter the sending of tracks.
Note that this message must be sent from the external client at least every 5 seconds. The track filter areas, once configured, will expire after 7 seconds unless they are refreshed. This also means there is no requirement to remove an area once its no longer required because it will automatically expire. |
Attributes | Description | Type | Notes |
MsgId | Unique message Id | Long | This must be globally unique across all message types |
MsgTimeStamp | Date and time that the message was sent | DateTime | |
UniqueId | Id of this area | Guid | This should be a unique Id that represents an area to allow tracks from |
Latitude1 | Top Left Latitude | Double | Top left latitude of tracker filter area |
Longitude1 | Top Left Longitude | Double | Top left latitude of tracker filter area |
Latitude2 | Bottom Right Latitude | Double | Bottom right latitude of tracker filter area |
Longitude2 | Bottom Right Longitude | Double | Bottom right latitude of tracker filter area |
Each incoming message can include an optional Sender element. This must include the IP address and port that the client is using to send instructions.
If the Sender element is included the NetworkAddress value will be checked against the subscriber IP address and the command rejected if they do not match.
In addition the Sender element is included in the Command Reply. This is a duplicate of the incoming details (i.e. the subscribers IP address and port). The subscriber can use this to verify that they authored the message.
Please note the following:
|