| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 330 |
| Technical Name |
odoo_socketio |
| License | AGPL-3 |
| Website | https://github.com/cd-feng |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 330 |
| Technical Name |
odoo_socketio |
| License | AGPL-3 |
| Website | https://github.com/cd-feng |
Odoo SocketIo
Real-time bidirectional communication for Odoo using Socket.IO technology
Overview
This module integrates Socket.IO with Odoo to enable real-time, event-based communication between the server and web clients. Perfect for building interactive features like live notifications, chat systems, and real-time updates.
Key Features
Real-time Communication
Instant message delivery between server and clients using WebSocket technology.
User-based Messaging
Target messages to specific users with built-in user connection management.
Room Support
Organize communication channels with room-based messaging.
Easy Integration
Simple JavaScript API for client-side integration with existing Odoo views.
Usage Examples
Server-side Python Example
// Send real-time notification to user
self.env['odoo.socketio'].push_socketio_event({
'event': 'user_notification',
'data': {'message': 'Your order has shipped!'},
'uid': user.id
})
Client-side JavaScript Example
// In your Odoo component
setup() {
this.socketioService = useService('socketio_service');
this.socketioService.on('user_notification', (data) => {
this.env.services.notification.add(data.message);
});
}
Technical Details
- Requires: Odoo 18.0+, python-socketio 5.13.0
- License: AGPL-3
- WebSocket Support: Yes (with fallback to long-polling)
- Performance: Runs in main Odoo process (recommend separate process for heavy loads)
Installation
- Install via Odoo Apps
- Configure port in Odoo config file:
[options] socketio_port = 3000
- Install Python dependency:
pip install python-socketio==5.13.0
Please log in to comment on this module