# freebird-netcore-ble
> Freebird netcore of ble
Latest version **0.2.0** (published 2019-06-14) · MIT license · 0 weekly downloads
## Install
```sh
npm install freebird-netcore-ble
pnpm add freebird-netcore-ble
yarn add freebird-netcore-ble
bun add freebird-netcore-ble
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-06-14 |
| First published | 2016-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 78.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Hedy Wang |
| Maintainers | hedywings |
## Links
- npm: https://www.npmjs.com/package/freebird-netcore-ble
- Repository: https://github.com/freebirdjs/freebird-netcore-ble
- Homepage: https://github.com/freebirdjs/freebird-netcore-ble#readme
- Issues: https://github.com/freebirdjs/freebird-netcore-ble/issues
- npm.io page: https://npm.io/package/freebird-netcore-ble
## Dependencies (5)
- [bipso](https://npm.io/package/bipso.md) ^1.4.0
- [busyman](https://npm.io/package/busyman.md) ^0.3.0
- [proving](https://npm.io/package/proving.md) ^0.1.0
- [ble-shepherd](https://npm.io/package/ble-shepherd.md) ^1.1.9
- [freebird-base](https://npm.io/package/freebird-base.md) ^0.4.6
## Recent versions
- 0.2.0 (latest) — 2019-06-14
- 0.1.7 — 2017-12-25
- 0.1.6 — 2017-07-07
- 0.1.5 — 2017-07-02
- 0.1.4 — 2017-02-22
- 0.1.2 — 2016-08-03
- 0.1.1 — 2016-07-26
- 0.1.0 — 2016-07-26
- 0.0.11 — 2016-07-22
- 0.0.10 — 2016-07-21
- 0.0.9 — 2016-07-17
- 0.0.8 — 2016-07-12
- 0.0.7 — 2016-07-12
- 0.0.6 — 2016-07-12
- 0.0.5 — 2016-06-23
- … 4 more at https://npm.io/package/freebird-netcore-ble/versions
## README
# freebird-netcore-ble
A ble machine network core for freebird framework.
[](https://nodei.co/npm/freebird-netcore-ble/)
[](https://travis-ci.org/freebirdjs/freebird-netcore-ble)
[](https://www.npmjs.com/package/freebird-netcore-ble)
[](https://www.npmjs.com/package/freebird-netcore-ble)
## Table of Contents
1. [Overiew](#Overiew)
2. [Installation](#Installation)
3. [Basic Usage](#Basic)
4. [APIs](#APIs)
## 1. Overview
**freebird-netcore-ble** is the network controller (netcore) with managment facilities ready for freebird.
## 2. Installation
> $ npm install freebird-netcore-ble --save
## 3. Basic Usage
* To use this netcore with freebird, register it to freebird in your app:
```js
var Freebird = require('freebird'),
createBleCore = require('freebird-netcore-ble');
var freebird,
bleCore = createBleCore('noble');
// Create freebird server and register freeebird-netcore-ble
freebird = new Freebird([ bleCore ]);
// Simply start the freebird server
freebird.start(function (err) {
freebird.permitJoin(180); // Let your netcores allow peripheral machines to join the network
});
// That's it!
```
## 4. APIs
#### 1. Basic API
**freebird-netcore-ble** exports a function `createBleCore()` to create BLE netcore, it will returns a [Netcore](https://github.com/freebirdjs/freebird-base/blob/master/docs/NetcoreClass.md#netcore-class) instance for network operating
* [createBleCore()](#API_createBleNc)
#### 2. Netcore APIs
Netcore provides you with the following APIs, please go to [Netcore APIs](https://github.com/freebirdjs/freebird-base/blob/master/docs/NetcoreClass.md#netcore-class) for their usage.
* Basic Methods
| Medthod | Description |
|--------------|----------------------------------------------------------------------------------------|
| getName | Get name of this netcore. |
| isEnabled | To see if this netcore is enabled. |
| isRegistered | To see if this netcore is registered to freebird framework. |
| isJoinable | To see if this netcore is currently allowing devices to join the network. |
| enable | Enable this netcore. |
| disable | Disable this netcore. |
| dump | Dump information about the netcore. |
* Network Management
| Medthod | Description |
|----------------|--------------------------------------------------------------------------------------------------|
| start | Start the network. To allow devices to join the network, use `permitJoin()`. |
| stop | Stop the network. All functions are disabled. |
| reset | Reset the netcore. Soft reset just restart the netcore, and hard reset will clear the blacklist. |
| permitJoin | Allow or disallow devices to join the network. |
| remove | Remove a remote device from the network. |
| ban | Ban a device from the network. Banned device can never join the network unless you unban it. |
| unban | Unban a device. |
| ping | Ping a remote device. |
| maintain | Maintain all remote devices of the netcore. |
| getTraffic | Get traffic records. |
| resetTraffic | Reset record of the traffic. |
| getBlacklist | Get blacklist of the banned devices. Use `ban()` to put a device into blacklist. |
| clearBlacklist | Clear the blacklist. Use `unban()` to release a device from blacklist. |
| isBlacklisted | To see if a device is banned. |
*************************************************
### createBleCore(subModule[, spConfig])
Create a BLE netcore with `cc-bnp` or `noble` sub-module.
* With `cc-bnp` sub-module: `createBleCore('cc-bnp', spConfig)`
* With `noble` sub-module: `createBleCore('noble')`
**Arguments**
* `subModule` (*String*): `subModule` can be either a string of `'cc-bnp'` or `'noble'` to specify the sub-module.
* `spConfig` (*Object*): This value-object has two properties `path` and `options` to configure the serial port.
* `path`: A string that refers to the serial-port system path, e.g., `'/dev/ttyUSB0'`.
* `options`: An object to set up the [seiralport configuration options](https://www.npmjs.com/package/serialport#serialport-path-options-opencallback).
**Returns**
- (*Object*): bleCore
**Example**
* Using `cc-bnp` as a sub-module:
```js
var createBleCore = require('freeebird-netcore-ble');
var bleCore = createBleCore('cc-bnp', {
path: '/dev/ttyUSB0',
options: {
baudRate: 115200, // default value
rtscts: true, // default value
flowControl: true // default value
}
});
```
* Using noble as a sub-module:
```js
var createBleCore = require('freeebird-netcore-ble');
var bleCore = createBleCore('noble');
```
---
_Source: https://npm.io/package/freebird-netcore-ble · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._