GuardRFID AllGuard

Definitions

RTLS — Real-Time Location System. RTLS devices are used to track the location of a person or object.
Tag — A tag is a physical device that tracks location for persons or objects.
RFID — Radio Frequency Identification. The use of electromagnetic fields used to uniquely identify an object.

Setup

See the Data Servers page for information on configuring driver communication.

Prerequisites


Software	Minimum Version
IPFusion — GuardRFID AllGuard	1.2
.NET Framework	4.7.2

When completing your setup, be sure to have the GuardRFID AllGuard documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.


Purpose	Default Value	Configurable
GuardRFID Server Connection	8889	No
Dataserver	9640	Yes
Debug Tools	9641	No

Communication Configuration

In the integrated system configuration panel, you will find the Communication Settings. The following information is required:

Connection Settings


IP Address	The IP Address of the GuardRFID server.

Workstation Account Credentials


Account Name	The username for the account used to log in to the Workstation running the GuardRFID software.
Password	The password for the account used to log in to the Workstation running the GuardRFID software.

Assets

Tag Exciter

This asset represents a Tag Exciter in the GuardRFID system. These are used to identify tags as they enter or leave an area.

Required Property Grid Fields


Tag Exciter ID	The identifier of the Tag Exciter within the GuardRFID system.

View all properties

Supported States


Normal	The asset is online and in its default state.
Masked	The asset has been masked over its true state.
Fault	An issue has been detected in a connected asset.
Acknowledged	An asset alarm has been acknowledged.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Acknowledge	Acknowledge an asset alarm.
Mask	Mask the asset's true state.
Cancel	Deselects all selected assets.
Reset	Resets the asset to its true hardware state.

See the Command Tables page for more information on configuring command tables.

System

The system asset is a representation of the connection state of the GuardRFID system.

View all properties

Supported States


Normal	The asset is online and in its default state.
Masked	The asset has been masked over its true state.
Fault	An issue has been detected in a connected asset.
Acknowledged	An asset alarm has been acknowledged.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Mask	Mask the asset's true state.
Acknowledge	Acknowledge an asset alarm.
Reset	Resets the asset to its true hardware state.
Cancel	Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Workflow Integration

Asset Events

Assets events are events used to trigger Workflow actions on an asset level. For more information about Workflows, see the Workflows section.

Tag Exciter Asset

Entering Field

This event occurs when a tag has entered a Tag Exciter's area.

Table 1. Properties
Tag Number	The number assigned to the tag.
Tag Type	The type of tag identified.
Tag ID	The identifier of the tag in the GuardRFID system.

Exiting Field

This event occurs when a tag has exited a Tag Exciter's area.

Table 2. Properties
Tag Number	The number assigned to the tag.
Tag Type	The type of tag identified.
Tag ID	The identifier of the tag in the GuardRFID system.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.