wivi_graph_client_ts

Description# wivi_graph_client

wivi_graph_client is a TypeScript client library designed to interact with the wivi_graph Apollo Server, enabling users to easily ingest and fetch data from the associated Timescale database. This library simplifies the process of interacting with your wivi_graph server and managing data requests, making it effortless to integrate with your TypeScript applications.

Table of Contents

• Installation
• Usage
• Features

Installation

You can install wivi_graph_client using npm or yarn:

npm install wivi_graph_client
# or
yarn add wivi_graph_client

Usage

Pre-Requisites: Running Wivi Graph Apollo Server

You can use this library by importing it into your project and using the built-in functions:

import { WiviGraphClient } from 'wivi_graph_client';

//Pass the url of the wivi graph server here to create the connection

const client = new WiviGraphClient(url);

//Sample function to get configuration
await client.getConfiguration({
  input: {
    deviceId: '8',
  },
});

The above piece of code will make connection with the server and get any configurations with deviceId = 8 from the database

Features

1. mdDeviceConfiguration Related Functions: a. getConfiguration b. createConfiguration

2. Version Info Related Functions: a. getVersionInfos b. upsertVersionInfo c. deleteVersionInfo

3. Device Info Related Functions: a. getDeviceInfo b. createDeviceInfo c. deleteDeviceInfo

4. Signal Related Functions: a. getSignal b. getSignalData c. upsertSignalData d. deleteSignalData

5. DTC Related Functions: a. getDtcData b. upsertDtcData c. deleteDtcData

6. Message Related Functions: a. getMessage b. createMessage

7. GPS related Functions: a. getGpsData b. upsertGpsData c. deleteGpsData

8. Formula related Functions: a. getFormula b. calculateFormula c. upsertFormula d. upsertFormulaConstant

9. Network Stats Functions: a. getNetworkStats b. createNetworkStats