Savona

Node.js library for talking to Sony PXW-Z190V cameras through the camera's Savona remote API.

This package is a lower-level controller wrapper. It exposes the camera's request methods and adds typed convenience structures for common camera state, settings, recording controls, media cards, uploads, and file-transfer jobs.

Installation

yarn add @ckohen/savona

Usage

import { SavonaClient } from '@ckohen/savona';

const client = new SavonaClient('camera.local', 'admin', 'password', {
	subscribeToNotifications: true,
});

await client.connect();

const status = await client.globalStatus.fetchValue();
const cards = await client.mediaCards.fetchValue();
const clips = await client.mediaCards.cardB.fetchClips();

await client.disconnect();

The client also exposes the raw Savona method groups when you need to work closer to the camera API:

await client.property.getValue({
	params: [{ 'System.Config': ['RemoteSetting'] }],
});

await client.clip.uploadFiles({
	params: [[['1001', 'media.2', '752_0437', ['http://camera/B/Clip/752_0437.MXF'], { absolute_dir: 'Archives' }]]],
});

Structures

Most camera areas are available as properties on SavonaClient:

• Camera controls: focus, iris, ND, shutter, gain, whiteBalance, slowAndQuick, colorBars, record
• Status/config: globalStatus, systemConfig, systemFunctions, deviceInfo, systemMessages
• File handling: mediaCards, uploadSettings, uploadJobs, autoUpload
• Low-level method groups: property, capability, process, system, clip, storage, button, notify, network

Set methods send values to the camera and do not optimistically mutate local state. Fetch again, or listen for notifications, when you need confirmed camera state.

Media And Uploads

Media cards are exposed as cardA, cardB, and cardC, corresponding to media.1, media.2, and media.3.

const clips = await client.mediaCards.cardB.fetchClips();
const settings = await client.uploadSettings.fetchValue();

const clip = clips[0];
const uploadSetting = settings.get(1001);

if (clip && uploadSetting) {
	await clip.upload(uploadSetting);
}

fetchClips() reads the camera's MEDIAPRO.XML media profile and handles the camera's digest-protected file server from Node, including the malformed HTTP headers sent by some camera firmware.

Upload setting IDs and upload job IDs are represented as numbers in this library, but are converted to strings for camera request parameters.

File Deletion Caveat

The camera advertises remote clip deletion only for proxy media. The high-level delete helpers therefore only allow deletion from media.3:

if (clip.canDelete) {
	await clip.delete();
}

Main-file deletion from media.1 or media.2 is not exposed by the high-level wrapper. The raw client.clip.delete(...) method remains available for experiments, but tested name/path/URL forms returned Invalid Argument on a PXW-Z190V, and System.Config.RemoteDeleteClip normalized back to type: ['proxy'].

Known Camera Behaviors

• Upload setting add/delete calls may return success while leaving the fixed camera slots unchanged, so this library exposes update/fetch behavior rather than add/remove helpers.
• Upload settings can use the saved FTP upload directory by passing an UploadSetting object, or by fetching settings first and then using a numeric setting ID.
• Some camera writes are eventually consistent; an immediate fetch may briefly return the previous value.
• The package has been live-tested against a PXW-Z190V, but other Sony cameras or firmware versions may expose different capability sets.

Development

yarn install
yarn lint
yarn build