⚠️ ALPHA RELEASE v3.1.0-alpha
This release includes API security, calibration system, and BMS integration features.
# Clone repository
git clone https://github.com/AutomataControls/IS0-10816-Vibration-Sensor.git
cd IS0-10816-Vibration-Sensor
# Run GUI installer
python3 install-gui.pywget https://raw.githubusercontent.com/AutomataControls/IS0-10816-Vibration-Sensor/main/install.sh
chmod +x install.sh
./install.shThe installer automatically:
- ✅ Detects GUI/CLI environment
- ✅ Installs all dependencies (uses --break-system-packages on newer systems)
- ✅ Creates desktop shortcuts with service control
- ✅ Configures SQLite database with 7-day retention
- ✅ Sets up API security with password protection
- ✅ Creates systemd service (manual start via desktop icon)
- ✅ Copies only runtime files to /opt/automatanexus/
- Multi-Port Monitoring - Handle sensors with same Modbus address using separate USB adapters
- ISO 10816-3 Compliance - Automatic vibration severity zones (A-D)
- 7-Day Database - SQLite with automatic retention management
- Real-Time Web Interface - Modern responsive dashboard accessible network-wide
- Equipment Profiles - Customizable for different motor types
- Sensor Calibration - Zero-point calibration and scaling factors for each sensor
- API Security - JWT token authentication with configurable passwords
- BMS Integration - Send metrics to Building Management Systems via InfluxDB protocol
- Background Operation - "Keep Running" option to close browser while service continues
- Network Access - Monitor from any device on your network
- Single Save Operation - "Save All Configurations" button for all sensors at once
- Raspberry Pi 3B+ or newer (4B recommended)
- 1-5 USB-to-RS485 adapters
- WitMotion WTVB01-485 sensors (Modbus RTU address 0x50)
- Python 3.8+
- Raspberry Pi OS (Bullseye or newer)
- GUI environment for installer (or use CLI installer)
- flask, flask-cors
- pyserial
- numpy
- PyJWT, python-dotenv
- bcrypt (optional, falls back to hashlib)
- Pillow (optional for GUI installer logos)
IS0-10816-Vibration-Sensor/
├── Runtime Files (Installed to /opt/automatanexus/)
│ ├── multi_port_vibration_monitor.py # Main monitoring application
│ ├── monitoring-app.html # Web dashboard interface
│ ├── automata-nexus-logo.png # Company logo
│ ├── uninstall.sh # Uninstaller script
│ ├── show-network-info.sh # Network utility
│ ├── docs/ # Documentation
│ │ ├── RASPBERRY_PI_SETUP.md # Detailed Pi setup
│ │ ├── NODE_RED_INTEGRATION.md # Node-RED guide
│ │ └── ISO-10816-Motor-Vibration-Guide.md
│ ├── tools/ # Diagnostic utilities
│ │ ├── diagnose_sensor.py # Sensor troubleshooting
│ │ └── change_sensor_address.py # Modbus address tool
│ └── node-red-contrib-*/ # Optional Node-RED package
│
├── Development Files (Not installed)
│ ├── install.sh # Master installer selector
│ ├── install-gui.py # GUI installer (Tkinter)
│ ├── install-on-pi.sh # CLI installer
│ ├── create-icon.py # Icon generator
│ ├── build-release.sh # Release builder
│ └── IS0-10816-Vibration-Monitor-UI/ # Tauri desktop app source
│
└── Generated Files (Created during runtime)
├── .env # API keys & BMS config
├── equipment_config.json # Sensor configurations
├── vibration_metrics.db # SQLite database
├── launch-monitor.sh # Desktop launcher
└── *.csv # Data export files
Access locally: http://localhost:5000/monitoring-app.html
Access from network: http://<raspberry-pi-ip>:5000/monitoring-app.html
- Real-time Monitoring - Live sensor readings with auto-refresh
- Vibration Trends - 24-hour trend graphs for each sensor
- Equipment Configuration - Configure motor specs for each sensor
- ISO Zone Indicators - Color-coded severity zones (A-D)
- Alert Notifications - Real-time alerts for zone C/D conditions
- Calibration Tab - Zero-point calibration and scaling adjustments
- BMS Integration - Link to Building Management System
- JWT token authentication (when enabled)
- Password protection set during installation
- 24-hour token expiry with refresh capability
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/auth/login |
Authenticate and receive JWT token |
| GET | /api/auth/check |
Verify authentication status |
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/readings |
Current sensor values with calibration applied |
| GET | /api/metrics/history |
Historical data (7 days) |
| GET | /api/metrics/summary |
Statistical summaries |
| GET | /api/metrics/alerts |
Zone C/D events |
| GET | /api/status |
System status and sensor health |
| POST | /api/configure |
Save sensor configuration |
| GET | /api/calibration/<port> |
Get calibration settings |
| POST | /api/calibration |
Update calibration settings |
| POST | /api/calibration/zero/<port> |
Perform zero-point calibration |
| POST | /api/bms/configure |
Configure BMS integration |
| GET | /api/bms/status |
BMS connection status |
| POST | /api/bms/toggle |
Enable/disable BMS sending |
Authorization: Bearer <your-jwt-token>
// Function node example with authentication
msg.url = "http://localhost:5000/api/readings";
msg.method = "GET";
msg.headers = {
"Authorization": "Bearer " + flow.get("vibration_token")
};
return msg;Import node-red-examples.json for complete flows including:
- Real-time monitoring with authentication
- Historical trends visualization
- Alert automation for zone C/D
- Dashboard widgets
The system can send metrics directly to your Building Management System using InfluxDB line protocol format:
vibration_metrics,location=<location>,system=<sensor_name>,equipment_type=<type>,equipment_hp=<hp> velocity_rms=<value>,acceleration_peak=<value>,temperature=<value>,iso_zone="<zone>",alert_active=<0|1> <timestamp>
Each sensor sends individual metrics with:
- system: The configured equipment name for that sensor
- location: Your facility location name
- Real-time values: Velocity, acceleration, temperature
- ISO compliance: Current zone (A-D) and alert status
Configure via the "Link to BMS" button in the web interface.
| Zone | Condition | 15-50 HP | 3-15 HP |
|---|---|---|---|
| A | Good | 0-2.3 mm/s | 0-1.4 mm/s |
| B | Acceptable | 2.3-4.6 mm/s | 1.4-2.8 mm/s |
| C | Unsatisfactory | 4.6-7.1 mm/s | 2.8-4.5 mm/s |
| D | Unacceptable | >7.1 mm/s | >4.5 mm/s |
ls /dev/ttyUSB* # Check USB devices
sudo usermod -a -G dialout $USER # Add permissions
# Logout and login for group changes to take effect# Service is NOT auto-started on boot
# Use desktop icon to start/stop service
# Check service status
sudo systemctl status vibration-monitor
# View service logs
sudo journalctl -u vibration-monitor -f
# Manual service control (if needed)
sudo systemctl start vibration-monitor
sudo systemctl stop vibration-monitor# Find Raspberry Pi IP address
hostname -I
# Check firewall (if enabled)
sudo ufw status
sudo ufw allow 5000/tcp # If needed- Default: Authentication is disabled
- If enabled during install, use the password you set
- Token expires after 24 hours
- Check .env file for configuration
/opt/automatanexus/IS0-10816-Vibration-Sensor/vibration_metrics.db
/opt/automatanexus/IS0-10816-Vibration-Sensor/.env # API keys and BMS config
/opt/automatanexus/IS0-10816-Vibration-Sensor/equipment_config.json # Sensor settings
- Email: DevOps@automatacontrols.com
- Documentation: Full Docs
- Issues: GitHub Issues
This software is commercially licensed by AutomataNexus AI & AutomataControls. See LICENSE for details.
- ✨ Added sensor calibration system with zero-point and scaling
- 🔐 Implemented JWT authentication with password protection
- 🏢 Added BMS integration with InfluxDB line protocol
- 🌐 Enabled network-wide access to monitoring interface
- 💾 Added "Save All Configurations" button
- 🏃 Added "Keep Running" button for background operation
- 🔧 Fixed GUI installer to handle installation from cloned repo
- 🖱️ Desktop icon now controls service lifecycle
- 📊 Individual sensor metrics sent to BMS with configured names
- 📦 Installer now copies only runtime files (excludes dev files)
- 🖼️ Fixed installer button heights and logo display
- 🎨 Updated UI with better Unicode icons and ultra-light colors
- 🔧 Fixed PIL compatibility for older Pillow versions
- 🗄️ SQLite database with 7-day retention
- 📈 Historical data API endpoints
- 🚨 Alert tracking and summaries
- 🔌 Multi-port sensor support
- 📱 Responsive web interface
- 🏭 ISO 10816-3 compliance
© 2025 AutomataNexus AI & AutomataControls | Building Intelligence Through Automation