@novastar/native

Structures and APIs in typescript automatically generated from decompiled NovaStar .NET libraries.

Go to API documentation.

Installation

Using npm:

npm install --save @novastar/native@next
Copy

or yarn:

yarn add @novastar/native@next
Copy

Usage

Since the native API contains more than 1000 methods, not all of which you will use, you can include the methods you need. To do this, create a file api.ts and import the functionality you need.

// api.ts

import '@novastar/native/api/ReadDviMode';
import '@novastar/native/api/ReadDviSelect';
import '@novastar/native/api/ReadGlobalBrightness';
import '@novastar/native/api/ReadIsHasDVI';
import '@novastar/native/api/ReadAllBrightnessInfo';
import '@novastar/native/api/ReadSelfTestMode';
import '@novastar/native/api/SetGlobalBrightness';
import '@novastar/native/api/SetSelfTestMode';
import '@novastar/native/api/SetGamma';
import '@novastar/native/api/ReadGamma';
import '@novastar/native/api/ReadScanner_McuProgramRemarks';
import '@novastar/native/api/ReadScanner_FPGAProgramRemarks';
Copy

Each import adds new methods to the Session class and extends API interface. If you import the file MethodName, then the async methods MethodName and tryMethodName will be added. The first method for reading the value will return a promise with a non-negative number if the response has a buffer size of 1, 2, or 4 bytes and a promise with a buffer otherwise. If the response is not received, or the status of the response contains an error, an exception will be rejected. The second method, which starts with try, will return the answer, or null if there is none. In this case, don't forget to check the status res.ack of the response .

Then create a Session.ts file that will export the resulting type containing all of your selected methods.

// Session.ts

import { API, Session } from '@novastar/codec';

import './api';

export type SessionAPI = API & Session;

export type { API };
Copy

Now you can use the resulting type:

import { net } from '@novastar/net';
import { SessionAPI } from './Session';

const session: SessionAPI = net.open('192.168.1.40');
await session.SetGamma(0, 0, 0, false, 2.6);
Copy

Structs and enumerations are also best imported via direct paths.

Enum types end with Enum in their names. Each file contains, in addition to the type, a codec that can be used to validate and convert input data. See io-ts for details.

The full code can be viewed at the link

import * as t from 'io-ts';
import { XMLParser, type X2jOptions } from 'fast-xml-parser';
import { isLeft } from 'fp-ts/Either';
import * as t from 'io-ts';
import { PathReporter } from 'io-ts/PathReporter';
import fs from 'fs';

import { SystemParameterConfig } from '@novastar/native/SystemParameterConfig';

const options: X2jOptions = {
  ignoreAttributes: false,
  parseTagValue: false,
};

const parser = new XMLParser(options);

/**
  Create a wrapper for the parser
*/
const makeCfgParser =
  <C extends t.Mixed>(codec: C) =>
  (data: Buffer): t.TypeOf<C> => {
    const cfg = parser.parse(data);
    const { decode } = t.exact(t.type({ [codec.name]: codec }));
    const res = decode(cfg);
    if (isLeft(res)) {
      throw new TypeError(PathReporter.report(res)[0]);
    }
    return res.right[codec.name];
  };

const systemParameterParser = makeCfgParser(SystemParameterConfig);

/**
 * *.scfg
 * @param pathname
 */
export const loadSystemConfig = (pathname: string): SystemParameterConfig => {
  const data = fs.readFileSync(pathname);
  return systemParameterParser(data);
};

Copy

Troubleshooting

Not all APIs have been automatically converted from decompiled code. In addition, the resulting code may contain errors. There is also no description of API, and we can only guess about its purpose based on its name. Unfortunately, many names may contain syntax and semantic errors (original names are preserved). Refer to the decompiled code if in doubt.

Important note

This repository contains C# scripts, some wrapping for the generated API, and the original binary libraries. All useful content is automatically generated from the decompiled code of binary libraries in generated folder. A description of the generated API is also available here.

Development

Install dependencies

pnpm install
Copy

To decompile binary libraries, dotnet version 8 or higher is required, and the ilspycmd package must also be installed.

To check the prerequisites, run the command

pnpm run requirements
Copy

To install ilspycmd run the command:

pnpm run ilspycmd:install
Copy

To automatically generate the typescript code, run the command:

pnpm run rebuild
Copy