Health

Fingermark Health related tasks

Overview

Fingermark Health includes all health related tasks for devices

Usage

Currently, we setup a heartbeat service and a service to check online status.

import { pingHealthService, checkOnlineStatus } from '@fingermarkglobal/health';
import { KioskSettingsComplete } from '@fingermarkglobal/types';

const settings: KioskSettingsComplete = {
  // Fingermark standard KAS settings
};

await pingHealthService({ serial: 'test', settings });
const booleanResponse = await checkOnlineStatus();

We've also bundled a service for reporting the kiosk version to Hawke. It would be a good idea to include this information directly within the heartbeat service someday and do away with the need for an extra endpoint and POI_APP_HAWKE- parameter.

import { reportKioskVersion } from '@fingermarkglobal/health';
import { KioskSettingsComplete } from '@fingermarkglobal/types';

const settings: KioskSettingsComplete = {
  // All of the following need to be defined in order for this function to work:
  // id (deviceSettingsId)
  // settings.properties.deviceId
  // settings.properties.storeId (also known as groupId)
  // settings.properties.organisation (organisationId)
};

await reportKioskVersion({ serial: 'test', settings });

Gotcha's

Please refer to @fingermarkglobal/types for more information on how payloads are typed.