Configuration — HID Amico Biometric Reader¶

Everything you can add with this adapter: where it goes in the tree, what you fill in, and what you can tell it to do.

Amico Terminal¶

HID Amico facial-recognition access terminal. One terminal per adapter instance.


Add it under	nothing — this is the top of the tree
Identified by	nothing — there is only one
Role	—

Setting	Required	Default	Accepted values	What it does
ip_address	yes	—	host name or IP address	Reader host or IP address
port	optional	`80`	1–65535	Port of the reader's web API
use_tls	optional	`false`	yes / no	Talk to the reader over HTTPS. The reader ships with its secure port switched off, so turn this on only after enabling it on the reader.
username	yes	—	text	Web API user name
password	optional	—	text	Web API password (stored as a secret)
identification_mode	optional	`AsConfiguredOnReader`	AmicoIdentificationMode	How the reader identifies a person, written at every connect. SingleFactor: a face, card, PIN or QR each identify alone. CardThenFace: a card is presented and the face verified 1:1 against that user. TemplateOnCard: the card carries the user id and the template (needs a Seos card and Elite/MOB keys loaded over Bluetooth; the value itself is measured, not documented). AsConfiguredOnReader leaves the reader's own setting untouched.
qr_identification	optional	`AsConfiguredOnReader`	AmicoFeatureToggle	Whether the reader matches scanned QR codes against the codes this system uploads. Disabled leaves it in the factory legacy mode, where it ignores them entirely and a correct code scans as 'not identified'. AsConfiguredOnReader leaves the reader's own setting untouched.
pin_identification	optional	`AsConfiguredOnReader`	AmicoFeatureToggle	Whether a PIN alone identifies a person at the keypad. AsConfiguredOnReader leaves the reader's own setting untouched.

Command	What happens
Mute Sounder	Silence siren alarm

The terminal's identification head — face, card, PIN, QR and password are all read here.


Add it under	Amico Terminal (up to 1)
Identified by	the one per parent (identity by type) you fill in below
Role	—

Command	What happens
Enroll Card	Start card enrollment process on reader
Enroll Face	Start face enrollment process on device

A door released by one of the terminal's built-in relays. Present on a VL70LF; a VL35LF has none.


Add it under	Amico Terminal (up to 4)
Identified by	the address you fill in below
Role	an access point people pass through

Setting	Link to	Required	What it is for
entry_reader	Amico Reader	yes	The head people identify at to open this door

Setting	Required	Default	Accepted values	What it does
address	yes	—	1–4	Number of the terminal relay that releases this door

Command	What happens
Open	Open door momentarily (unsecure strike temporarily)
Lockdown	Activate emergency lockdown - deny all access
Cancel Lockdown	Cancel emergency lockdown - return to normal operation
Evacuation	Activate evacuation mode - unsecure all egress doors
Cancel Evacuation	Cancel evacuation mode - return to normal operation

A door released by an external access module (EAM) wired to the terminal. On a VL35LF this is the only door.


Add it under	Amico Terminal
Identified by	the address you fill in below
Role	an access point people pass through

Setting	Link to	Required	What it is for
entry_reader	Amico Reader	yes	The head people identify at to open this door

Setting	Required	Default	Accepted values	What it does
address	yes	—	a number	Identifier the reader reports for this access module. Read it from the reader rather than assuming a value.

Command	What happens
Open	Open door momentarily (unsecure strike temporarily)
Lockdown	Activate emergency lockdown - deny all access
Cancel Lockdown	Cancel emergency lockdown - return to normal operation
Evacuation	Activate evacuation mode - unsecure all egress doors
Cancel Evacuation	Cancel evacuation mode - return to normal operation

One of the terminal's supervised alarm inputs, as configured on the reader.

Setting	Required	Default	Accepted values	What it does
address	yes	—	1–5	Alarm zone number as configured on the reader

A general-purpose input on a VL70LF terminal. A VL35LF has none. State is read by polling, so a pulse shorter than the poll interval is not seen.

Setting	Required	Default	Accepted values	What it does
address	yes	—	1–3	Input pin number on the terminal (1-3)