Skip to content
Sofie: The Modern TV News Studio Automation System (Server Core Integration library)
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
config
examples
src
.editorconfig
.gitignore
CHANGELOG.md
LICENSE
README.md
jest-integration.config.js
jest.config.js
package.json
tsconfig.build.json
tsconfig.json
tslint.json
yarn.lock

README.md

Sofie: The Modern TV News Studio Automation System (Server Core Integration)

CircleCI codecov

This library is used to connect to the Sofie Server Core from other Node processes.

This is a part of the Sofie TV News Studio Automation System.

Getting started

Typescript

import { CoreConnection, PeripheralDeviceAPI } from 'tv-automation-server-core-integration'

// Set up our basic credentials:
let core = new CoreConnection({
	deviceId: 'device01', 			// Unique id
	deviceToken: 'mySecretToken',	// secret token, used to authenticate this device
	deviceType: PeripheralDeviceAPI.DeviceType.PLAYOUT,
	deviceName: 'My peripheral device'
})
core.on('error', console.log)
// Initiate connection to Core:
core.init({
	host: '127.0.0.1',
	port: 3000
}).then(() => {
	// Connection has been established
	console.log('Connected!')
	// Set device status:
	return core.setStatus({
		statusCode: PeripheralDeviceAPI.StatusCode.GOOD,
		messages: ['Everything is awesome!']
	})
})
.catch((err) => {
	console.log(err)
})

Development

  • Installation
    • Install Yarn from https://yarnpkg.com
    • Install Jest, yarn global add jest
    • Install npm dependencies, yarn
  • Build
    • Build, yarn build
    • Run tests, yarn test
    • Run tests & watch, yarn watch
You can’t perform that action at this time.