Alarms and status

Annunciator `<smart-annunciator>`

Annunciator displays a wall of tiles, one per monitored condition, following the ISA-18.1 alarm sequence: normal, alarm (unacknowledged, blinking fast), acknowledged (steady) and ringback (cleared but not reset, blinking slowly).

Getting Started with Vue Annunciator Component

Smart.Industrial supports Vue 3.2.38 and later, with Vite. Vue uses the custom elements directly, so there is no wrapper to install.

The complete demo in Vue is on the demo page, file by file.

Scaffold with Vite (Vue 3)

The official scaffolding tool creates the project:

npm create vue@latest

The tool asks about TypeScript, Router, Pinia and other options. The defaults are enough for the sample.

cd <your-project-name>
npm install
npm install smart-industrial
npm run dev

Vue + TypeScript

A TypeScript project has vite.config.ts in place of vite.config.js, with the same configuration.

Teach Vue about custom elements

The isCustomElement option of the Vue plugin passes smart-* tags to the browser as custom elements. Without it, Vue looks for a Vue component named smart-annunciator and warns that it cannot resolve it. Other plugins that the scaffold added, such as vueDevTools(), stay in the list.

import { fileURLToPath, URL } from 'node:url'

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          isCustomElement: (tag) => tag.startsWith('smart-')
        }
      }
    })
  ],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url))
    }
  }
})

App.vue example

The sample replaces src/App.vue. It imports the stylesheets and the module that defines <smart-annunciator>, sets the properties the demo sets and handles the acknowledge event.

<script setup>
import 'smart-industrial/source/styles/smart.default.css';
import 'smart-industrial/source/styles/smart.industrial-elements.css';
import 'smart-industrial/source/styles/smart.industrial.css';
import 'smart-industrial/source/modules/smart.annunciator.js';

// Raised when an operator presses a tile that is in the alarm state, or through
// acknowledgeAll.
function onAcknowledge(event) {
  const { tile } = event.detail;
  // The component waits. The application carries out the request here.
  console.log('acknowledge', tile);
}
</script>

<template>
  <smart-annunciator
    theme="industrial"
    :columns="4"
    @acknowledge="onAcknowledge"
  ></smart-annunciator>
</template>

Strings are plain attributes. Numbers and booleans are bound with a colon, such as :columns="4". A plain attribute would hand the property a string, and a property that takes a number or a boolean rejects a string with an error.

A listener for an event with an uppercase letter in its name, such as @tileClick, needs Vue 3.2.38 or later. Earlier versions listen for tile-click, which the component never raises.

With TypeScript, the script tag is <script setup lang="ts"> and the handler's parameter is typed as CustomEvent.

Run and build

The development server runs at http://localhost:5173/:

npm run dev

The production build goes to ./dist:

npm run build