ModbusBox Client Library

ModbusBox Client Library for device monitor and control across applications.

Installation

npm install @iotbits-io/mbox-ui-client

Or using yarn:

yarn add @iotbits-io/mbox-ui-client

Features

• API for ModbusBox interactions
• Support for Web and Node.js environments
• Built-in utilities for common tasks

Usage

Import the library

In a JavaScript/TypeScript file, import the library:

import { MBoxClient } from '@iotbits-io/mbox-ui-client';

Example

const deviceIp = "192.168.4.1"

const client = new MBoxClient(deviceIp);

// Subscribes to status updates.
client.onStatusUpdate((status) => {
    console.log(status);
});

// Subscribes to device error messages
client.onDeviceError((error) => {
    console.log(error);
});

// Flash LED to locate device
await client.locate();
 
// Get Device Info 
const deviceInfo = await client.getInfo();
console.log(deviceInfo);

API Documentation

For more details on the API, check the API Documentation.

Development

To build the library:

npm run build

To generate documentation:

npm run docs

Release

To release a new version of this project, simply push your commits to the main branch or merge a pull request. The GitHub Actions workflow will automatically trigger Semantic Release, which will analyze your commit messages to determine the type of version bump needed (major, minor, or patch). The new version will then be automatically published to NPM, and a corresponding GitHub Release will be created, complete with auto-generated release notes. Ensure your commit messages adhere to Angular Commit Message Conventions to take full advantage of this feature.

• Patch: For fixes (fix:)
• Minor: For new features (feat:)
• Major: For breaking changes (BREAKING CHANGE:)

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
  │                          elements|forms|http|language-service|localize|platform-browser|
  │                          platform-browser-dynamic|platform-server|router|service-worker|
  │                          upgrade|zone.js|packaging|changelog|docs-infra|migrations|
  │                          devtools
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

License

This project is licensed under the MIT License - see the LICENSE file for details.