xble_mimic_api v0.2.13

XBLE Mimic API

Javascript BLE mocking api for React Native written in typescript.

This is a WIP. Building out to my internal needs but the goal is to extend to match the actual module 1:1.

Documentation Site

Documentation Site

BLE Manager

This module is meant to run locally only with the Mimic app to mock BLE using http/websockets.

Built of the spec for "react-native-ble-plx" plugin.

react-native-ble-plx docs

Dependency

This module currently is meant to be used along with the XBLE Mimic APP. The app allows you to set up data, create devices, and exposes the http/websocket endpoints on localhost:3000.

XBLE Mimic App

Install

npm i xble_mimic_api

import { module } from 'xble_mimic_api'

Build

Typescript compiler for type declarations. Rollup and babel used for bundling.

Build an output file and type declarations

npm run build

Run types and bunding in watch mode

npm run build:watch

Run only types

npm run build:types

Run type checking

npm run type-check

Local Development

To run locally you will want to npm link the package.

NOTE: If you link then unlink a package you must run your install command again.

* Inside xble_mimic_api
npm link

* Inside Application
npm link xble_mimic_api

Testing

Testing uses Jest and 100% coverage is required.

Run tests

npm run test

Run tests in watch mode

npm run test:watch

Run tests coverage report

npm run test:coverage

Create typedocs

npm run typedoc