CAN-Bridge is a hardware adaptation bridge service developed in Golang, specifically designed to support efficient and stable data communication for devices using the CAN (Controller Area Network) protocol.
The project aims to provide an easy-to-use HTTP API interface, allowing users to send and receive CAN messages, manage interface configurations, and monitor device status via network requests, while also supporting dynamic configuration of multiple CAN interfaces.
-
Interface Setup Manager:
- Automatically executes
ip link set can0 up type can bitrate 1000000 - Configurable bitrate, sample point, and restart timeout
- Provides retry mechanism and error handling
- Supports interface state querying and validation
- Automatically executes
-
Enhanced Configuration System:
- Supports configuration via command-line parameters and environment variables
- Provides configuration validation to ensure parameter correctness, including bitrate
- Includes detailed usage instructions
-
Comprehensive Interface Management API:
- Configuration management API (
GET /api/setup/config,PUT /api/setup/config) - Interface operation API (setup, shutdown, reset, status query)
- Batch operation API (setup or teardown all interfaces at once)
- Configuration management API (
- Dynamic Interface Configuration: Supports dynamic configuration of multiple CAN interfaces (e.g.,
can0,can1) via command-line or environment variables. - HTTP API Service: Provides easy-to-use RESTful API interfaces.
- Message Sending and Validation: Supports sending standard CAN messages and performs validation of data length and interface availability.
- Health Check and Automatic Recovery: Built-in interface health monitoring with automatic recovery of failed interfaces.
- Real-time Monitoring and Statistics: Offers monitoring of interface status, message statistics, success rates, error logging, and average latency.
- ✅ Automatic Initialization: Automatically configures CAN interfaces on program startup.
- ✅ Retry Mechanism: Automatically retries interface setup upon failure.
- ✅ Status Monitoring: Real-time monitoring of interface status and error statistics.
- ✅ Graceful Shutdown: Automatically shuts down interfaces upon program exit.
- ✅ Dependency Injection: Facilitates testing and extension.
- ✅ Error Handling: Comprehensive error handling and logging.
Supports installation on bare-metal systems, Docker containers, and source code builds.
For detailed installation instructions, see the Installation Guide.
Basic Usage
./can-bridge -can-ports can0,can1Custom Bitrate
./can-bridge -can-ports can0 -bitrate 500000Disable Automatic Setup (Managed via API)
./can-bridge -auto-setup=falseConfigure Interface via API
curl -X POST localhost:5260/api/setup/interfaces/can0 \
-H "Content-Type: application/json" \
-d '{"bitrate": 500000, "withRetry": true}'http://localhost:5260/api
Configuration Management:
GET /api/setup/configPUT /api/setup/config
Interface Operations:
GET /api/setup/availablePOST /api/setup/interfaces/{name}DELETE /api/setup/interfaces/{name}POST /api/setup/interfaces/{name}/resetGET /api/setup/interfaces/{name}/state
Batch Operations:
POST /api/setup/interfaces/setup-allPOST /api/setup/interfaces/teardown-all
- Implements retry mechanisms for reliable message transmission.
- Utilizes mutex locks to ensure thread safety.
- Real-time monitoring of interface health status with automatic recovery.
Logs are output to the standard output stream in a friendly format, including clear error messages and runtime status information.
Deployment using systemd or Docker containers is recommended to ensure long-term stable operation.
Issues and Pull Requests are welcomed to improve and optimize the project.
This project is licensed under the Apache-2.0 license.