# 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)