Safety and interlocks

Permissive `<smart-permissive>`

Permissive displays a list of conditions that a start requires or that a running device depends on, with whether each condition is met.

JavaScript TypeScript Angular React Vue Blazor

<smart-permissive> · 8 properties, 2 methods, 3 events · source/modules/smart.permissive.js

Usage in Angular

The Angular wrapper is PermissiveComponent from PermissiveModule: every property is an input, every event an output named on<Event>, and the methods are called on the component reference from @ViewChild. A method that returns a value returns a Promise of it, resolved once the component has rendered; its ...Sync() twin returns the value at once, or null before the component has rendered. Unknown bindings are rejected at compile time.

import { PermissiveModule, PermissiveComponent } from 'smart-industrial/angular/permissive';

<smart-permissive #permissive [label]="'P-2101A start permissives'" [allowBypass]="true"
    (onBypassRequest)="onBypassRequest($event)"></smart-permissive>

@ViewChild('permissive', { read: PermissiveComponent }) permissive!: PermissiveComponent;
// methods are called on the component reference; this one returns a Promise
const result = await this.permissive.summary();

Properties

Input	Type, default	Description
`[conditions]` conditions	array	Sets or retrieves the conditions as [{ id, label, satisfied, required, bypassed, bypassedBy, tag, value, description, timestamp }]. required defaults to true; an advisory condition is listed but never blocks. timestamp is the time the condition last changed state and is used to determine the first-out condition. Assign a new array to update the component. Flags given as text, as a tag database may hand them over, are read as such: 'false', '0', 'no', 'off' and '' are not set.
`[mode]` mode	PermissiveMode permissive	Sets or retrieves the type of the list. A permissive list gates a start, and the verdict reads ready or not permitted. An interlock list trips a running device, the verdict reads healthy or tripped, and the first-out condition is marked.
`[label]` label	string	Sets or retrieves the title of the list, usually the device name and the purpose of the list.
`[showFirstOut]` showFirstOut	boolean true	Determines whether the earliest unsatisfied required condition, by timestamp, is marked as first-out. Applies in interlock mode only. Conditions without a timestamp cannot be first-out, and a tie is reported as no first-out.
`[showSatisfied]` showSatisfied	boolean true	Determines whether met conditions are listed. When off, a long list shows only the conditions that block; the verdict still counts every condition.
`[showTimestamps]` showTimestamps	boolean true	Determines whether each condition shows how long it has been in its state, from its timestamp. The ages tick without the rows being rebuilt.
`[allowBypass]` allowBypass	boolean false	Determines whether a bypass control is offered on each required condition that blocks, and a removal control on each bypassed one. The control raises bypassRequest and changes nothing itself.
`[announceChanges]` announceChanges	boolean true	Determines whether a change of verdict is read through the live region, assertively for a trip, politely otherwise.

Methods

Method	Description
`summary(): Promise<any>` and `summarySync(): any`	Returns a summary of the list as { total, required, satisfied, unsatisfied, bypassed, ready, blocking, firstOut }, where blocking is the ids of the required conditions that are not met and firstOut is an id or null. With no conditions, ready is false: an empty list permits nothing.
`conditionById(id: any): Promise<any>` and `conditionByIdSync(id: any): any`	Returns the condition with the given id, as the application supplied it, or null. `id` string The condition's id.

Events

The data of an event is in event.detail. bypassRequest is a request: the bypass button appears only while allowBypass is true, and the component keeps the condition as it is until the application sets bypassed on it in conditions. readyChange reports a change of the overall verdict, and conditionClick reports a click on a row.

Output	Description and detail
`(onReadyChange)` readyChange	This event is triggered when the verdict changes, a start becomes possible or a device trips, and not on every redraw. It also fires when the list is emptied (ready false, nothing blocking) and when it is filled again. `ready` boolean Whether every required condition is met or bypassed. `blocking` any[] The ids of the required conditions not met. `firstOut` string The id of the first-out condition, or null.
`(onBypassRequest)` bypassRequest	This event is triggered when a bypass control is pressed. The list is not changed; the application applies the bypass, records who applied it, and returns an updated list. It is raised once per press: the control waits for the application's updated list, or five seconds, before it asks again. Each bypass control is named after its condition. `id` string The condition's id. `bypass` boolean True to apply a bypass, false to remove one. `condition` object The condition as the application supplied it.
`(onConditionClick)` conditionClick	This event is triggered when a condition row is clicked, so that the application can open the faceplate or trend of the tag. `id` string The condition's id. `condition` object The condition as the application supplied it.

Types

`type PermissiveMode`

'permissive' | 'interlock'

CSS variables

The component declares 6 CSS variables; the CSS page shows how to set them.

--smart-permissive-blocked-color --smart-permissive-blocked-fill --smart-permissive-bypass-color --smart-permissive-bypass-fill --smart-permissive-ready-color --smart-permissive-met-color