onvif-cli/src/index.ts

onvif cli to interact with ONVIF devices

#! /usr/bin/env node
import PromptService from "./services/prompt.service"
import validator from 'validator';
import { OnvifDevice } from "node-onvif-ts-extended";
import { logError, logJSON, logLoading, logSuccess, logTable } from "./helpers/logger";
import CLIService from "./services/cli.service";
import IDeviceInfo from "./interfaces/cli/deviceInfo.interface";
import Capabalities from "./interfaces/onvif/capabilities.interface";
import { Scopes } from "./interfaces/onvif/scopes.interface";
import OnvifServiceCLI from "./services/onvif.service";
import flattenObject from "./helpers/flattenObject";


let deviceInfo: IDeviceInfo;
let device: OnvifDevice;

console.log("Welcome to the interactive ONVIF CLI");
console.log("Before we get started, please provide the ONVIF device credentials");


async function cli() {
    try {
        let answer;    
        let onvifService: OnvifServiceCLI;

        if(!deviceInfo){
            deviceInfo = await CLIService.getDeviceInfo();
            // Create & Init an OnvifDevice object
            device = await CLIService.initOnvifDevice(deviceInfo);
        }


        onvifService = new OnvifServiceCLI(device);

        // Ask the user for an action
        answer = await PromptService.list(
            "Please choose an action",
            "action",
            [
                "device-information",
                "get-capabilites",
                "get-onvif-profiles",
                "get-recordings",
                "get-streaming-uri",
                "change-device",
                "exit"
            ]
        );

        // Execute a logic depending on the chosen action
        switch (answer["action"]) {
            case "device-information":
                console.log("the following table shows device details:");
                logTable(device.getInformation())
                break;
            case "get-capabilites":
                //get capabalities using onvif
                const capabilites = await onvifService.getCapabilities();
                //ask user to select a specific capabilities
                const field = await CLIService.selectCapabilities();
                // display the capability field
                const selectedField = OnvifServiceCLI.getCapabilityField(capabilites, field);
                logTable(selectedField)

                break;
            case "get-onvif-profiles": {
                const profiles = await onvifService.getOnvifProfiles();
                logTable(profiles);
                break;
            }
            case "get-recordings": {
                const uris = await onvifService.getReplayUriList()
                logTable(uris)
                break;
            }
            case "get-streaming-uri": {
                const streamingUri = await onvifService.getStreamingUri();
                logJSON(streamingUri);
                await CLIService.askToPlayRTSPUri(OnvifServiceCLI.setupRtspUrl(streamingUri, deviceInfo.username, deviceInfo.password))
                break;
            }
            case "change-device": {
                deviceInfo = await CLIService.getDeviceInfo();
                device = await CLIService.initOnvifDevice(deviceInfo);
                break;
            }
            case "exit": {
                console.log("Bye! thanks for using ONVIF CLI");
                process.exit()
            }
            default:
                break;
        }

    } catch (error) {       
        logError(error);
    } finally {
        // loop cli
        cli();
    }
}


cli()