kiwrious-webserial

kiwrious-webserial-library

Kiwrious web serial sdk features reading sensor data from kiwrious sensors. Mainly supported for web apps runs on chromium based web browers.

Install

npm install kiwrious-webserial

Setup dependencies

Download all files from this link Sensor Decoder Resources Place them inside your public folder / js link all js files

<script type="text/javascript" src="js/libunicorn.out.js"></script>
<script type="text/javascript" src="js/libelf-integers.js"></script>
<script type="text/javascript" src="js/unicorn-wrapper.js"></script>
<script type="text/javascript" src="js/unicorn-constants.js"></script>
<script type="text/javascript" src="js/heartrate.js"></script>

Configure webpack

resolve: {
    extensions: ['.tsx', '.ts', '.js'],
}

Import

import serialService from 'kiwrious-webserial/lib/service/SerialService';
import {SensorReadResult} from "kiwrious-webserial/lib/data/SensorReadResult";
import {SensorDecodedValue} from "kiwrious-webserial/lib/data/SensorDecodedValue";

Use

connect

// calling this method will invoke browser's usb serial connection prompt
// plugin your kiwirous sensor, select it press connect
await serialService.connectAndReadAsync();

subscribe

serialService.onSerialData = (decodedData: SensorReadResult) => {
    const values = decodedData.decodedValues as SensorDecodedValue[];
    const no_of_observables = values.length;
    // Light - kiwrious uv sensor - 2 observables (uv, lux)
    // Climate - kiwrious humidity sensor - 2 observables (temperature, humidity)
    // EC - kiwrious conductivity sensor - 1 observable (conductivity)
    // Cardio - kiwrious heart rate sensor - 1 observable (pulse)
    // Thermal - kiwrious body temperature sensor - 2 observables (ambient temperature, infrared temperature)
    // Air - kiwrious voc sensor - 1 observable (voc)
    const label = values[0].label; // name of the first observable (ex. Temp for temperature)
    const value = values[0].value; // value of the first observable (ex. temperature value in celcius)
}

API

• read sensor values onSerialData?: (data: SensorReadResult) => void;

• check connectivity onSerialConnection?: (connected: boolean) => void;

• check for firmware update onFirmwareUpdateAvailable?: (available: boolean) => void;

• connect and read connectAndReadAsync(): Promise<void>;

• disconnect sensor triggerStopReading(): void;