Ctrlx-datalayer-flatbuffers NPM

Bosch Rexroth ctrlX Data Layer Node.js API Flatbuffers

This is a Flatbuffers library for the ctrlX Data Layer Node.js API.

Usage

Quick Overview

This library provides generated TypeScript classes of FlatBuffers models for use in the ctrlX Data Layer API for Node.js.

Install

npm install ctrlx-datalayer-flatbuffers --save

Usage

The following code snippet demonstrates how to create a FlatBuffers byte buffer with the FlatBuffers builder and the provided TypeScript classes:

//Build metadata
const builder = new flatbuffers.Builder(1024);

//Setup allowed operations   
const operationsOffset = AllowedOperations.createAllowedOperations(
    builder, true, true, false, false, true);

const descriptionOffset = builder.createString('my description');
const descriptionUrlOffset = builder.createString('my descriptionUrl');
const displayNameOffset = builder.createString('my displayName');
const unitOffset = builder.createString('my unit');

//Setup metadata
Metadata.startMetadata(builder);
Metadata.addDescription(builder, descriptionOffset);
Metadata.addDescriptionUrl(builder, descriptionUrlOffset);
Metadata.addDisplayName(builder, displayNameOffset)
Metadata.addUnit(builder, unitOffset);
Metadata.addNodeClass(builder, NodeClass.Variable);
Metadata.addOperations(builder, operationsOffset);

const offset = Metadata.endMetadata(builder);
Metadata.finishMetadataBuffer(builder, offset);

const metaDataBytes = builder.asUint8Array()

Samples

It might be helpful to have a look at the README Node.js Apps @ ctrlX document to find implementations of the different use-cases.

Support

This repository is provided and maintained by Bosch Rexroth.

Developer Community

Feel free to check out and be part of the ctrlX AUTOMATION Community. Get additional support, e.g. related to Bosch Rexroth Devices, Apps, SDKs and Services, or leave some ideas and feedback.

SDK Forum

Please join the discussions in the SDK Forum ctrlX AUTOMATION:

Issues

To report bugs, request changes and discuss new ideas you may also have a look at the issue tracker of this repository: https://github.com/boschrexroth/ctrlx-automation-sdk/issues

License

SPDX-FileCopyrightText: Bosch Rexroth AG SPDX-License-Identifier: MIT

Terms and Conditions for the Provision of Products of Bosch Rexroth AG Free of Charge

See LICENSES/tc_for_provision_of_products_free_of_charge.pdf inside this package. Please download the latest version from https://www.boschrexroth.com. Navigate to Legal Notice (footer) -> Terms and Conditions for the Provision of Products Free of Charge
See LICENSES/*.fossinfo.xml for used open source software licenses.