tinycv

function onEnumerationUsbEndpointFinish(err, usbEndpoints) {
    if (err != null) {
        console.log(err);
    }

    console.log("usbEndpoint size : ", usbEndpoints.length);

    usbEndpoints.forEach(function(usbEndpoint) {
        console.log("uniqueId : ", usbEndpoints.GetUniqueId());
        console.log("subDevices : ");
        const devices = usbEndpoints.GetSubDevices();
        devices.forEach(function(device) {
            console.log("deviceName : ", device.deviceName);
            console.log("unqiueId: ", device.uniqueId);
            console.log("instanceId : ", device.instanceId);
            console.log("type : " , device.type);
        });
    });
}

Devicemanager.enumerateUsbEndpoint(onEnumerationUsbEndpointFinish);

UsbEndpoint

usb端点类，其中包含了此usb下的一堆子设备, 和一个uniqueId，这个唯一ID可以用来唯一标识这个UsbEndpoint，他其实就是devicePath

UsbEndpoint
instance

getSubDevices

注意：子设备只会包含HID、Camera、Microphone、Loudspeaker、storage几种类型，其余类型会被自动过滤

Param: 无

Retrun: array<Device>

Devcie

设备基础信息类，其中保存类设备名称、设备路径、设备实例ID、设备所属类型，这个类不需要你手动去构造，会通过函数UsbEndpoint.getSubDevices() 返回

Device
- new Device()
- property
- method
  - .convertToChromiumDeviceId
- type
  - DeviceType

new Device()

Device构造函数

| Param| Type| | -------- | --------| | deviceName| String| | devicePath| String| | instanceId| String| | deviceType| DeviceType|

deviceName

获取设备显示名称

Return : String

uniqueId

获取设备路径

Return : String

instanceId

获取设备实例ID

Return: String

deviceType

获取设备类型

Return: DeviceType

type

获取设备类

DeviceType

camera ( 0 )
microphone (1)
loudspeaker (2)
hid (3)
storage (4)

js定义

const deviceType = {
  camera: 0,
  mircrophone: 1,
  loudspeaker: 2,
  hid: 3,
  storage: 4,
  none: 5
};

chromiumUniqueId

获取chromium的uniqueId，这个路径主要是给convertToChromiumDeviceId使用

convertToChromiumDeviceId

生成和chromium一样的device_id和group_id

| Param| Type| | ------| -----------| |chromiumUniqueId| String| |salt| String| |frameOrigin| String|

第一个参数chromiumUniqueId它可以通过device.chromiumUniqueId获取
第二个参数在electron程序中，可以通过读取%appdata%/YOU_APP_NAME/Preferences来获取，他是一个JSON文件，文件中有一个{"device_id_salt":"F60EF71327A385940BA58205AF50DCD7"}, 第二个参数就是要填写device_id_salt的值
第三个参数他是你的root域名
- 当地址栏为空时，frameOrigin为 "chrome://new-tab-page"
- 当导航栏地址为"file://xxx"时，frameOrigin为 "file://"
- 其他情况是你当前请求页面的root域名

example

const device = new Device("deviceName", "uniqueId", "instanceId", 2);
console.log(device.uniqueId);
device.devicePath = "uniqueId2";
device.convertToChromiumDeviceId(device.chromiumUniqueId, "F60EF71327A385940BA58205AF50DCD7", "https://www.qq.com")

TinycvCamera

caemra管理类，包含了几个方法，Open和Close，Open用来打开一个Camera，使用Close来关闭一个Camera，其中Open方法是异步, Get提供给你方便获取已经Open过到capture

TinycvCamera
- static


function onOpen(err, capture) {
if (err == null) {
    console.log(err);
    return;
}

// Dosomething

// Close
}

const uniqueId = "xxx"; // uniqueId可以从DeviceManger里面获取到，或者从UsbMonitor
TinycvCamera.open(uniqueId, onOpen);

open

| Param| Type| | ------| -----------| |uniqueId| String| |callback| function(err, capture)|

close

调用Open函数之后，记得使用close关闭

| Param| Type| | ------| -----------| |uniqueId| String|

get

如果你调用了open函数成功了之后，在open callback之外还需要使用到capture对象，请使用这个函数获取capture对象, 如果对应的capture不存在，将会返回null

| Param| Type| | ---------| -----------| | uniqueId| String|

VideoCapture

摄像头实际操作类，对象会通过Open创建

VideoCapture
- interface

注意注意：在没有拿到画面的时候，获取当前值和设置当前值都是无效的

startCapture 开始视频捕获，在调用这个函数之前必须先调用setCapturehandler函数
stopCapture 停止视频捕获，一般情况下用不到，使用TinycvCamera.close代替
setCaptureHandler 设置视频流处理函数，函数类型function(frame), frame类型是VideoFrameARGB
zoom 数码变焦，int32
pan 全景
Tilt 倾斜
getZoomValueRange、getPanValueRange、getTiltValueRange获取对应value范围
setBrightness 设置亮度
setContrast 设置对比度
setSaturation 设置饱和度
setSharpness 设置锐度
setHue 设置色彩
setPowerLineFrequency 设置电力线频率，也就是防闪烁
getBrightness 获取亮度
getContrast 获取对比度
getSaturation 获取饱和度
getSharpness 获取锐度
getHue 获取色彩
getPowerLineFrequency 获取电力线频率，也就是防闪烁
getCapabilitys 获取所有capabilitys，返回类型 array VideoCaptureAbility

Get* 返回值

{
    minValue: 0,
    maxValue: 100,
    value: 50,
    step: 1, // 如果step是1，你就不能设置50.5, 只能以step为增值或者减值
    defValue: 50,  // 默认值
    flag: 1 // 1自动，2手动
}

example

const uniqueId = "xxx"; // uniqueId可以从DeviceManger里面获取到，或者从UsbMonitor

function onFrame(frame) {
    console.log(frame.size);
    console.log(frame.width);
    console.log(frame.height);
}

function onStartCaptured(err) {
    console.log(TinycvCamera.get().getSharpness());
}

function onOpen(err, capture) {
    if (err == null) {
        console.log(err);
        return;
    }

    console.log(capture.getBrightness());
    cpature.setBrightness(50);

    capture.setCaptureHandler(onFrame);
    capture.startCapture(onStartCaputred);
}

TinycvCamera.open(uniqueId, onOpen);

VideoCaptureAbility

VideoCaptureAbility
- property

VideoFrameARGB

只读

VideoFrameARGB
- property

UsbMonitor

UsbMonitor
- static

所有方法都是静态,可以直接调用, SetDeviceInsertedHandler,SetDeviceRemovedHandler必须在调用Start方法之前

example

function onDeviceAdded(usbEndpoint) {
    const uniqueId = usbEndpoint.getUniqueId();
    const subdevices = usbEndpoint.getSubDevices();
}

function onDeviceRemoved(usbEndpoint) {
// Usb移除只有唯一id
    const uniqueId = usbEndpoint.getUniqueId();
}

UsbMonitor.setDeviceInsertedHandler(onDeviceAdded);
UsbMonitor.setDeviceRemovedHandler(onDeviceRemoved);
UsbMonitor.start();

Fireware

Fireware
- new Fireware()
- property
- interface
  - .upgrade

一个Fireware代表一个固件，其中分为两大模块，固件基础信息，和固件升级，固件基础信息包含固件名称、固件版本、固件SN、固件PN、固件OTAKEY等

new Fireware

| Param| Type| Desc| | -------- | --------| ----------- | | UsbEndpoint| UsbEndpoint| 升级固件的Usb设备端点|

在创建Fireware对象时需要一个UsbEndpoint对象，这个对象可以通过DeviceManager.enumerateUsbEndpoint函数结合你当前open的Camera的Device来判断出该选择哪一个UsbEndpoint

注意 new Fireware在失败情况下会抛异常，请注意处理

onupgradefinished

onupgradefinished类型是一个function, 在调用upgrade函数之后，所有的结果通知都通过这个函数告知使用者, 请在调用Upgrade之前设置这个属性

函数原型:

onupgradefinished = function(firewareFilePath, code, msg) {
};

code 取值范围:

// 除了0以外的都是失败
const upgradeState = {
  succeed: 0,
  updateAlreadyExists: 1,
  invaildFirewareFile: 2,
  alreadyNewestVersion: 3,
  firewareFileOversize: 4,
  switchUpgradeModeFailed: 5,
  findScsiDeviceFailed: 6,
  readFirewareFileContentFailed: 7,
  scsiLoadFailed: 8,
  writeUpgradeDataFailed: 9,
  checkUpgradeResultFailed: 10,
  versionCheckFailed: 11
  notSupport: 12
};

onupgradeprogressupdated

onupgradeprogressupdated类型时一个function，在调用Upgrade函数之后，后续的更新进度会通过这个函数告知使用者，请在调用Upgrade之前设置这个属性

函数原型:

// value是进度值，取值范围 1 - 100
onupgradeprogressupdated = function(value) {
};

upgrade

固件升级接口，Upgrade是一个异步接口，所有反馈都通过onupgradefinished和onupgradeprogressupdated通知, 当收到onupgradefinished的通知时，代表更新已经完成，code表达了更新的结果，当code时succeed时，更新成功.

警告：一个Fireware代表一个固件，不要试图同时多次对一个Fireware调用upgrade，这样你将会收到updateAlreadyExists错误

| Param| Type| Desc | | ---------| -----------| --------------| | firewarePath| String| 固件升级文件路径, 必须是UTF-8格式 | | force| Boolean| 是否采用强制升级，如填true，将不会进行版本检查|

example

// usbEndpoint 可以使用 DeviceManager.EnumerationUsbEndpoint函数获取
const fireware = new Fireware(usbEndpoint);

// 基础信息获取
console.log(fireware.name)
console.log(fireware.version)
console.log(fireware.sn)
console.log(fireware.pn)
console.log(fireware.otakey)

//  升级之前的初始化
fireware.onupgradeprogressupdated = function(value) {
    console.log(value);
};

fireware.onupgradefinished = function(firewareFilePath, code, msg) {
    console.log("code : " + code);
    if (code != updateState.succeed) {
        // 升级失败
        console.log("msg: " + msg);
    } else {
        // 升级成功
    }
};


fireware.upgrade(firewareFilePath, false);

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

tinycv-node

支持操作系统

Install依赖

Install

功能概述

tinycv addon-api 接口指南

Classes

DevcieManager

enumerateUsbEndpoint

UsbEndpoint

Devcie

new Device()

deviceName

uniqueId

instanceId

deviceType

type

DeviceType

chromiumUniqueId

convertToChromiumDeviceId

TinycvCamera

open

close

get

VideoCapture

VideoCaptureAbility

VideoFrameARGB

UsbMonitor

Fireware

new Fireware

onupgradefinished

onupgradeprogressupdated

upgrade

example