Documentation
Everything you need to get the most out of Firebrain Module
Quick Start Guide
Get up and running with Firebrain Module in minutes
Step 1: Installation
# Install Firebrain Module
npm install firebrain-module
# Or using yarn
yarn add firebrain-module
Step 2: Basic Configuration
import Firebrain from 'firebrain-module';
const firebrain = new Firebrain({
apiKey: 'your-api-key',
deviceId: 'your-device-id'
});
Step 3: Start Monitoring
firebrain.start();
firebrain.onAlert((alert) => {
console.log('Alert:', alert);
});
Documentation Sections
Explore our comprehensive documentation library
Getting Started
Quick start guide and basic setup instructions
- Installation
- First Configuration
- Basic Setup
- Initial Testing
Configuration
Detailed configuration options and settings
- Device Setup
- Alert Rules
- Dashboard Customization
- User Management
API Reference
Complete API documentation and examples
- Authentication
- Endpoints
- Webhooks
- SDK Examples
Security
Security best practices and guidelines
- Authentication
- Data Encryption
- Access Control
- Compliance
Troubleshooting
Common issues and their solutions
- Connection Issues
- Alert Problems
- Performance
- Error Codes
Integrations
Third-party integrations and connectors
- Popular Platforms
- Custom Integrations
- Webhooks
- Data Export
API Examples
Common API usage patterns and examples
Send Custom Alert
POST /api/v1/alerts
{
"deviceId": "device-123",
"message": "Temperature threshold exceeded",
"severity": "high",
"data": {
"temperature": 85.5,
"threshold": 80.0
}
}
Get Device Status
GET /api/v1/devices/device-123/status
Response:
{
"status": "online",
"lastSeen": "2025-01-15T10:30:00Z",
"batteryLevel": 85,
"signalStrength": -45
}
Need Help?
Can't find what you're looking for? Our support team is here to help.