# freebird-base

> Base classes for freebird

Latest version **0.4.8** (published 2019-06-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install freebird-base
pnpm add freebird-base
yarn add freebird-base
bun add freebird-base
```

## 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.4.8 |
| Published | 2019-06-05 |
| First published | 2016-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 308.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Simen Li |
| Maintainers | hedywings, simenkid |

## Links

- npm: https://www.npmjs.com/package/freebird-base
- Repository: https://github.com/freebirdjs/freebird-base
- Homepage: https://github.com/freebirdjs/freebird-base#readme
- Issues: https://github.com/freebirdjs/freebird-base/issues
- npm.io page: https://npm.io/package/freebird-base

## Dependencies (3)

- [busyman](https://npm.io/package/busyman.md) ^0.3.0
- [proving](https://npm.io/package/proving.md) ^0.1.0
- [freebird-constants](https://npm.io/package/freebird-constants.md) ^0.2.3

## Recent versions

- 0.4.8 (latest) — 2019-06-05
- 0.4.7 — 2017-05-05
- 0.4.6 — 2017-02-18
- 0.4.5 — 2017-02-16
- 0.4.4 — 2017-02-16
- 0.4.3 — 2017-02-16
- 0.4.2 — 2017-02-10
- 0.4.1 — 2017-01-16
- 0.4.0 — 2016-12-13
- 0.3.0 — 2016-11-14
- 0.2.9 — 2016-11-10
- 0.2.8 — 2016-10-19
- 0.2.7 — 2016-09-21
- 0.2.6 — 2016-09-12
- 0.2.5 — 2016-09-09
- … 16 more at https://npm.io/package/freebird-base/versions

## README

# freebird-base
Base classes used in freebird framework.  

[![NPM](https://nodei.co/npm/freebird-base.png?downloads=true)](https://nodei.co/npm/freebird-base/)  

[![Travis branch](https://img.shields.io/travis/freebirdjs/freebird-base/master.svg?maxAge=2592000)](https://travis-ci.org/freebirdjs/freebird-base)
[![npm](https://img.shields.io/npm/v/freebird-base.svg?maxAge=2592000)](https://www.npmjs.com/package/freebird-base)
[![npm](https://img.shields.io/npm/l/freebird-base.svg?maxAge=2592000)](https://www.npmjs.com/package/freebird-base)


<br />
  
## Documentation  

Please visit the [Wiki](https://github.com/freebirdjs/freebird-base/wiki).


<br />

## Overview

**freebird-base** provides three base classes used by [freebird](https://github.com/freebirdjs/freebird) IoT framework. These classes are abstractions of the network controller, network device, and real appliance, respectively.  
  
| Class                        | Description                                                                         | Example                                                                               |
|------------------------------|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| [Netcore](https://github.com/freebirdjs/freebird-base/wiki/Netcore-Class) | A network controller responsible for message transportation and network management. | A zigbee coordinator or a BLE central controller.                                     |
| [Device](https://github.com/freebirdjs/freebird-base/wiki/Device-Class)   | A wired/wireless machine in the network.                                            | A zigbee end-device, a BLE peripheral, a MQTT client, or a CoAP server(LWM2M client). |
| [Gadget](https://github.com/freebirdjs/freebird-base/wiki/Gadget-Class)   | Something specific and functional in our life.                                      | A temperature sensor, a light switch, or a barometer.                                 |
  

  
* If you are a freebird user, you may only care about the APIs of [Device](https://github.com/freebirdjs/freebird-base/wiki/Device-Class) and [Gadget](https://github.com/freebirdjs/freebird-base/wiki/Gadget-Class) classes.  
* If you are a freebird netcore implementer who likes to create a netcore to manage your network with the freebird framework, then [Workflow of Designing Your Own Netcore](https://github.com/freebirdjs/freebird-base/wiki/Workflow) will be a good place for you to start.  


<br />

## Installation

> $ npm install freebird-base --save
  
<br />

  

## License

Licensed under [MIT](https://github.com/freebirdjs/freebird-base/blob/master/LICENSE).

  
<br />
  
<br />

---
_Source: https://npm.io/package/freebird-base · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._