# bfs-backend-example

> bits-fusion backend example

Latest version **0.0.3** (published 2023-07-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install bfs-backend-example
pnpm add bfs-backend-example
yarn add bfs-backend-example
bun add bfs-backend-example
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-07-14 |
| First published | 2023-07-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | drsanti |

## Links

- npm: https://www.npmjs.com/package/bfs-backend-example
- npm.io page: https://npm.io/package/bfs-backend-example

## Dependencies (7)

- [ws](https://npm.io/package/ws.md) ^8.13.0
- [cors](https://npm.io/package/cors.md) ^2.8.5
- [helmet](https://npm.io/package/helmet.md) ^7.0.0
- [express](https://npm.io/package/express.md) ^4.18.2
- [serialport](https://npm.io/package/serialport.md) ^11.0.0
- [@types/express](https://npm.io/package/@types/express.md) ^4.17.17
- [bfs-backend-example](https://npm.io/package/bfs-backend-example.md) ^0.0.1

## Recent versions

- 0.0.3 (latest) — 2023-07-14
- 0.0.2 — 2023-07-14
- 0.0.1 — 2023-07-14

## README

# bfs-backend-example package

This package has been specifically designed and implemented for use in `bits-fusion` workshops. It is intended to be utilized in a Node.js environment with TypeScript. The package serves as a wrapper for two dependencies, namely `serialport` and `express`, and offers straightforward APIs to facilitate rapid development.


### Install dependencies
Go to project directory and install dependencies
```
npm install bfs-backend-example
```

---

## Examples

### Example 1 - Serial Port
```ts
/**
 * Example 1 - Serial Port
 * What is your port name?
 * - Windows: Open device manager
 * - Mac: Run `ls /dev/tty.*` in terminal
 */
import { McuSerial } from 'bfs-backend-example';
const PORT_NAME = "COM1"; //!! <-- DEPENDED ON YOUR SYSTEM
new McuSerial(PORT_NAME, {
    onOpen: (link: McuSerial) => {
        link.send("pwmd/3/0.99");
    },
    onData: (data) => {
        console.log(data);
    },
});
```

### Example 2 - Simple Web Server
```ts
/**
 * Example 2 - Simple Web Server
 */
import { WebServer } from 'bfs-backend-example';
new WebServer();
```

### Example 3 - Simple Web Server with MCU
```ts
/**
 * Example 5 - Simple Web Server with MCU
 * Note:
 *  - Check and set serial port name.
 *  - Goto `http://localhost:3000/mcu` to get MCU message.
 */
import { McuSerial, WebServer } from 'bfs-backend-example';
new WebServer(new McuSerial("COMx"));//!! <-- DEPENDED ON YOUR SYSTEM
```

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