Skip to content
This repository was archived by the owner on Apr 11, 2024. It is now read-only.

Commit be80672

Browse files
committed
Updating package README
1 parent 9f01c6f commit be80672

File tree

2 files changed

+4
-58
lines changed

2 files changed

+4
-58
lines changed

README.md

Lines changed: 2 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -5,60 +5,6 @@
55
![platforms](https://img.shields.io/badge/platform-windows%20%7C%20osx%20%7C%20linux-lightgray.svg)
66
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
77

8-
Re-usable IoT data modules that you can use to create your own IoT application using the Forge Data Visualization Extension (Beta).
8+
Re-usable IoT data modules that you can use to create your own IoT application using the Forge Data Visualization Extension.
99

10-
For more information, see the [Data Visualization Extension (Beta) Developer's Guide](https://forge.autodesk.com/en/docs/dataviz/v1/developers_guide/).
11-
12-
## Installing and Using the Modules
13-
14-
For full instructions for installing and running the Data Visualization Extension (Beta) Reference Application and supporting modules, see the [Data Visualization Extension (Beta) QuickStart](https://forge.autodesk.com/en/docs/dataviz/v1/developers_guide/quickstart/).
15-
16-
To install only this module:
17-
18-
```bash
19-
npm install forge-dataviz-iot-data-modules
20-
```
21-
22-
To import the data modules:
23-
24-
```javascript
25-
//To import client-side data modules.
26-
import { X } from "forge-dataviz-iot-data-modules/client";
27-
28-
// To import server-side data modules.
29-
const { Y } = require("forge-dataviz-iot-data-modules/server");
30-
```
31-
32-
## Contents
33-
34-
This package contains client-side and server-side modules. Server-side modules (or gateways) interact with the corresponding data provider. For example, AzureGateway interacts with Azure Time Series Insights API in order to retrieve specific sensor data.
35-
36-
Client-side modules convert the data obtained from the corresponding DataGateway object into a consistent data format. For more details on how the client-side and server-side IoT data modules interact, see [Creating a Custom Data Adapter](https://forge.autodesk.com/en/docs/dataviz/v1/developers_guide/advanced_topics/custom_data_adapter/)
37-
38-
### Client-side modules:
39-
40-
- QueryParam
41-
- PropertyValue
42-
- AggregatedValues
43-
- PropertyData
44-
- DeviceData
45-
- Device
46-
- DeviceProperty
47-
- DeviceModel
48-
- EventType
49-
- EventSource
50-
- QueryCompletedEventArgs
51-
- Session
52-
- DateTimeSpan
53-
- DataView
54-
- DataStore
55-
- DataAdapter
56-
- AzureDataAdapter
57-
- RestApiDataAdapter
58-
59-
### Server-side modules:
60-
61-
- AzureGateway
62-
- CsvDataGateway
63-
- DataGateway
64-
- SyntheticGateway
10+
Full instructions on how to use the package can be found [here](https://forge.autodesk.com/en/docs/dataviz/v1/developers_guide/npm_packages/data_modules/)

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "forge-dataviz-iot-data-modules",
3-
"version": "0.1.8",
3+
"version": "0.1.9",
44
"description": "IoT data modules used by https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app",
55
"author": "Autodesk Inc",
66
"license": "Apache-2.0",
@@ -38,4 +38,4 @@
3838
"webpack": "^5.11.0",
3939
"webpack-cli": "^4.5.0"
4040
}
41-
}
41+
}

0 commit comments

Comments
 (0)