node-red-contrib-adxl-vibration-fft/README.md

Node-RED nodes for Analog Devices' ADXL series FFT(Fast Fourier Transform) stream data parser

node-red-contrib-adxl-vibration-fft
===

[![GitHub release](https://img.shields.io/github/release/CANDY-LINE/node-red-contrib-adxl-vibration-fft.svg)](https://github.com/CANDY-LINE/node-red-contrib-adxl-vibration-fft/releases/latest)
[![master Build Status](https://travis-ci.org/CANDY-LINE/node-red-contrib-adxl-vibration-fft.svg?branch=master)](https://travis-ci.org/CANDY-LINE/node-red-contrib-adxl-vibration-fft/)

Node-RED nodes for Vibration Measurement using:
1. Analog Devices' [EVAL-ADXL100X Vibration Sensor Evaluation Board](http://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-ADXL100X.html) and [EV-COG-AD4050 ARM Cortex M4F MCU](http://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EV-COG-AD4050.html) with the special [firmware for FFT (Fast Fourier Transform)](https://www.analog.com/jp/landing-pages/003/form/jp_sensor_pv_vibration.html)
1. [EMQuest-VA](https://www.uquest.co.jp/em/va.html) by UQUEST, LTD.

The nodes work with other MCU boards using the same UART protocol as the above firmware as well.

![Vibration Sensor Device](images/adxl100x-sensor-device.jpg)

## Example Flow

The bundled example flow provides the following demonstrations:

- Show FFT value chart with FFT peak value refreshed every second on Dashboard
- Show FFT peak value (frequency and amplitude) on Dashboard

# Prerequisites

## Supported Hardwares

### Analog Devices
- [EVAL-ADXL1002Z](https://www.analog.com/jp/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-ADXL100X.html#eb-buy) ... MEMS Accelerometers
- [EV-COG-AD4050LZ](https://www.analog.com/jp/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EV-COG-AD4050.html#eb-buy) ... Microcontroller development board
- [EV-GEAR-EXPANDER1Z](https://www.analog.com/jp/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EV-COG-AD4050.html#eb-buy) ...  Expansion board for bread boarding
- [2-conductor Shielded Cable](https://oyaide.com/catalog/products/2794.html)
- USB cable (Type A - microUSB) for connecting EVAL-ADXL1002Z board to Raspberry Pi
- Frequency range is 0-20KHz.

### UQUEST, LTD.
- [EMQuest-VA](https://www.uquest.co.jp/em/va.html) with an extra USB serial cable
- Frequency range is 0.05-1.5KHz.

## Software

### Analog Devices
- Firmware for this node is available at [analog.com/jp](https://www.analog.com/jp/landing-pages/003/form/jp_sensor_pv_vibration.html). User registration is required.

### UQUEST, LTD.
- Firmware is pre-installed (proprietary licensed software)

# How to install

## Node-RED users

Use `Manage Palette` dialog in the browser editor or run the following commands:
```
cd ~/.node-red
npm install node-red-contrib-adxl-vibration-fft
```

Then restart Node-RED process.


### Uninstallation

The following command uninstalls SmartMesh SDK python executables/libraries as well as this node package.

```
cd ~/.node-red
sudo npm uninstall --unsafe-perm node-red-contrib-adxl-vibration-fft
```

## CANDY RED users

Use `Manage Palette` dialog in the browser editor or run the following commands:
```
cd /opt/candy-red/.node-red
sudo npm install --unsafe-perm node-red-contrib-adxl-vibration-fft
```

Then restart `candy-red` service.

```
sudo systemctl restart candy-red
```

### Uninstallation

`Manage Palette` dialog should work for uninstallation as well as the following commands:

```
cd /opt/candy-red/.node-red
sudo npm uninstall --unsafe-perm node-red-contrib-adxl-vibration-fft
```

The above command uninstalls SmartMesh SDK python executables/libraries as well as this node package.

# Appendix

## How to build

```
# build
$ NODE_ENV=development npm run build
# package
$ NODE_ENV=development npm pack
```

# License

- Source Code ... ASL 2.0 ©CANDY LINE INC.
- Node Icon ... [CC BY-ND 3.0](https://creativecommons.org/licenses/by-nd/3.0/) © [icon8](https://icons8.com)

# Revision History
* 3.1.0
  - Add an experimental feature to read data from UQUEST EMQuest-VA with ADXL1002

* 3.0.1
  - Fix an issue where sensor data was not sent after reconnecing serialport

* 3.0.0
  - Add support for new edge device (UQUEST EMQuest-VA)
  - Improve serialport reconnection

* 2.0.0
  - Fix an issue where the node didn't work on Node-RED v1+

* 1.1.1
  - Fix node definition errors

* 1.1.0
  - Add Node.js v12 support
  - Drop Node.js v8 support

* 1.0.1
  - Add help text

* 1.0.0
  - Initial Release