# iviumjs

> A tiny NodeJS wrapper around the for IviumSoft.

Latest version **0.1.4-beta** (published 2023-02-13) · Apache License 2.0 license · 0 weekly downloads

## Install

```sh
npm install iviumjs
pnpm add iviumjs
yarn add iviumjs
bun add iviumjs
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4-beta |
| Published | 2023-02-13 |
| First published | 2022-12-23 |
| Weekly downloads | 0 |
| License | Apache License 2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | raulmarindev, gnpd |
| Keywords | ivium compactstat, ivium software, ivium, iviumsoft, node, typescript |

## Links

- npm: https://www.npmjs.com/package/iviumjs
- Repository: https://github.com/sf-tec/ivium.js
- Homepage: https://github.com/sf-tec/ivium.js#readme
- Issues: https://github.com/sf-tec/ivium.js/issues
- npm.io page: https://npm.io/package/iviumjs

## Dependencies (3)

- [ffi-napi](https://npm.io/package/ffi-napi.md) ^4.0.3
- [ref-napi](https://npm.io/package/ref-napi.md) ^3.0.3
- [ref-array-di](https://npm.io/package/ref-array-di.md) ^1.2.2

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.1.4-beta (latest) — 2023-02-13
- 0.1.3-beta — 2023-02-10
- 0.1.2-beta — 2023-01-09
- 0.1.1-beta — 2023-01-09
- 0.1.1-alpha — 2022-12-23
- 0.1.0-alpha — 2022-12-23

## README

# Ivium.js

Tiny NodeJS wrapper around the "Software development driver DLL" for IviumSoft.

## Important:

This module uses a dll from the IviumSoft application. You need to have this software installed on a Windows machine. The IviumSoft application can be downloaded from here: https://www.ivium.com/support/#Software%20update

This version of IviumJS has been tested for IviumSoft release 4.1100.

## Installation

Install Ivium.js easily with npm:

```
npm install iviumjs
```

## Usage Example (Using IviumSoft Core functions)

To use the same functions available in the "IviumSoft driver DLL" you can import the Core class as follows. All functions return a result code (integer) and a result value if available. For further information you can check the IviumSoft documentation.

```
import {Core} from 'iviumjs'

Core.IV_open()
Core.IV_getdevicestatus()
Core.IV_close()
```

## Usage Example (Using Ivium methods)

This is a wrapper around the Core functions that adds a few things:

- Exception management (you can find an example [here](https://github.com/SF-Tec/ivium.js/blob/main/docs/error_management.md))
- New functionalities

```
import {Ivium} from 'iviumjs'

Ivium.openDriver()
Ivium.getDeviceStatus()
Ivium.closeDriver()
```

## Supported functions

The list of currently supported and implemented functions can be found [here](https://github.com/SF-Tec/ivium.js/blob/main/docs/method_list.md).

## Authors

- Alejandro Gutiérez ([@funnelExtruder](https://twitter.com/funnelExtruder))
- Raúl Marín ([@raulmarindev](https://twitter.com/raulmarindev))

## Security

If you believe you have found a security vulnerability in Ivium.js, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email `rmarin@sftec.es` to disclose any security vulnerabilities.

## Links

- [See on GitHub](https://github.com/SF-Tec/ivium.js)
- [See on NPM](https://www.npmjs.com/package/iviumjs)

---
_Source: https://npm.io/package/iviumjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._