MercuryInputInfo

Represents the an input point on a Mercury Downstream Interface.

This is how a Mercury Input peripheral is stored

MercuryInputInfo Properties

Item -> BaseInfo -> PeripheralInfo -> MercuryPeripheralInfo -> MercuryInputInfo

Field Type Inherited from Description
Href String Item Gets or sets the href.
CommonName String BaseInfo Common Name of the resource.The common name of the resource.
InFolderHref String BaseInfo relative path Href value for the containing folderAll objects exist within a folder. Even folders!
InFolderKey String BaseInfo Represents the internal ID of the containing folder
IsGlobal Boolean BaseInfo If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects.
Key String BaseInfo Represents the internal ID of the object.
Links List<Link> BaseInfo List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required.
Metadata MetadataItem[] BaseInfo The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data.
Monikers MonikerItem[] BaseInfo the set of Monikers for this object
Notes NoteInfo[] BaseInfo The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted.
ObjectLinks ObjectLinkItem[] BaseInfo The set of resources that are related to this resourceFrequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set.
Tags String[] BaseInfo the set of tags for this objectTags are used to group objects together for the purposes of selection and assignment of operation rights
BacnetReadOnly Nullable<Boolean> MercuryPeripheralInfo Flag to indicate if this peripheral is enabled for BACNet.
ControllerCommonName String MercuryPeripheralInfo Gets or sets the name of the controller common.
ControllerHref String MercuryPeripheralInfo Gets or sets the controller href.
ControllerIndex Int32 MercuryPeripheralInfo Gets or sets the index of the controller.
ControllerKey String MercuryPeripheralInfo Gets or sets the controller key.
SioIndex Int32 MercuryPeripheralInfo Gets or sets the index of the sio.
SioNumber Int32 MercuryPeripheralInfo Gets or sets the sio number.
Status PeripheralStatusItem MercuryPeripheralInfo Gets or sets the status.
Behaviour Int32 MercuryInputInfo Gets or sets the behaviour. 0 = Normally Closed, 1 = Normally Open, 2 = Normally Closed (Supervised), 3 = Normally Open (Supervised)
Debounce Int32 MercuryInputInfo Gets or sets the debounce. Number of consecutive input scans, which must agree before a change of state is reported. The scan period is 16.7 milliseconds. Recommended setting for REX is 2, and 4-6 for standard input. Use higher settings only if you are receiving noise induced fault reports. Valid scan period multiplier values are 0 through 15.
EntryDelay Nullable<Int32> MercuryInputInfo Gets or sets the entry delay. In Seconds.
ExitDelay Nullable<Int32> MercuryInputInfo Gets or sets the exit delay. In Seconds.
HoldTime Nullable<Int32> MercuryInputInfo Gets or sets the hold time. Which is the number of seconds to hold a higher priority status before a lower priority status is reported. The recommend setting is 2 through 15. If null, the value will be 0 for REX and 2 for all other inputs.
IsDisabled Boolean MercuryInputInfo Gets or sets the IsDisabled flag. If set true the the system will logicallly un-program the input to prevent it from flooding the controller and the system with events.
LatchMode Int32 MercuryInputInfo Gets or sets the latch mode. 0 = Normal Mode (No exit or entry delay), 1 = Non-Latching Mode, 2 = Latching ModeLatching means that once the door is opened, regardless if the door is shut again, the alarm will go off, (unless monitor point masked). This transaction will show an “alarm” transaction code. Non-Latching means that if the door is opened and then immediately closed (within the entry delay), then the alarm would not go off. You still get a transaction when the Change-of-state happens, but the transaction code is not “alarm”.

JSON Structure of MercuryInputInfo

{
   "Href"	:	"String",
   "CommonName"	:	"String",
   "InFolderHref"	:	"String",
   "InFolderKey"	:	"String",
   "IsGlobal"	:	"Boolean",
   "Key"	:	"String",
   "Links"	:	"List\<[Link](/object-model/link)\>",
   "Metadata"	:	"[MetadataItem](/object-model/metadataitem)[]",
   "Monikers"	:	"[MonikerItem](/object-model/monikeritem)[]",
   "Notes"	:	"[NoteInfo](/object-model/noteinfo)[]",
   "ObjectLinks"	:	"[ObjectLinkItem](/object-model/objectlinkitem)[]",
   "Tags"	:	"String[]",
   "BacnetReadOnly"	:	"Nullable\<Boolean\>",
   "ControllerCommonName"	:	"String",
   "ControllerHref"	:	"String",
   "ControllerIndex"	:	"Int32",
   "ControllerKey"	:	"String",
   "SioIndex"	:	"Int32",
   "SioNumber"	:	"Int32",
   "Status"	:	"[PeripheralStatusItem](/object-model/peripheralstatusitem)",
   "Behaviour"	:	"Int32",
   "Debounce"	:	"Int32",
   "EntryDelay"	:	"Nullable\<Int32\>",
   "ExitDelay"	:	"Nullable\<Int32\>",
   "HoldTime"	:	"Nullable\<Int32\>",
   "IsDisabled"	:	"Boolean",
   "LatchMode"	:	"Int32"
}