open-index/open-npm huggingface dataset:
npm package: @open-iot-service-platform/oisp-cli
Description: OISP Command Line Interface
Author: Intel, CPG
Latest version: 1.2.0


# OISP CLI

The OISP Command-Line Interface allows you to perform common operations on an OISP instance using the REST API interface.

For an overview of the operations available see the [REST API](https://github.com/Open-IoT-Service-Platform/platform-launcher/wiki/REST-API) documentation.

## Getting Started

### Configuration
Before using the CLI you need to configure it so it knows how to communicate with your OISP instance. The CLI looks for the configuration file 'config.json' in the 'config' directory. A template is provided in the 'config' directory which you can copy and modify using your favourite text editor.
``` bash
cp config/config.json.template config/config.json
```

### Usage
To see a list of available commands run the following:
``` bash
./oisp-cli.js -h
```

## License

Copyright (c) 2014, Intel Corporation

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of Intel Corporation nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
npm package: @open-iot-service-platform/oisp-sdk-js
Description: OISP SDK for Node.js
Author: Intel
Latest version: 1.4.2

# OISP SDK for Node.js
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FOpen-IoT-Service-Platform%2Foisp-sdk-js.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FOpen-IoT-Service-Platform%2Foisp-sdk-js?ref=badge_shield)


## SparkPlugB standard support added

1. SparkplugB standard uses MQTT protocol to exchange data

Current implementation of library handles sending following requests

- Node Birth message
- Device Birth Message
- Data message

Node Birth/Device Birth and Data message have same format with change in contents of metrics.

Data message looks like below:

``` bash
    var cid = "0c574252-31d5-4b76-bce6-53f2c56b544d";
    var DataMessage = {
            timestamp: 12345,
            metrics: [{
                name : "temp",
                alias : cid,
                timestamp : 12345,
                dataType : "float",
                value: 123
            }],
            seq: 1
         };
```


## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FOpen-IoT-Service-Platform%2Foisp-sdk-js.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FOpen-IoT-Service-Platform%2Foisp-sdk-js?ref=badge_large)