.TH KYSDK-DBUS-WEBSOCKET 1 "2025" "Version 1.0" "User Commands"
.SH NAME
kysdk-dbus-websocket \- KYLIN SDK D-Bus to WebSocket Bridge

.SH SYNOPSIS
.B kysdk-dbus-websocket

.SH DESCRIPTION
.B kysdk-dbus-websocket
is a background service that provides a bridge between D-Bus system services and WebSocket connections. This service enables JavaScript applications to access KYLIN SDK D-Bus interfaces through WebSocket connections, facilitating web-based interaction with system-level functionality.

The service acts as a proxy that translates WebSocket messages to D-Bus method calls and signals, allowing web applications to interact with native system services without direct D-Bus access.

.SH FEATURES
.TP
.B D-Bus to WebSocket Bridge
Translates between D-Bus protocol and WebSocket protocol
.TP
.B JavaScript Interface
Provides web-based access to D-Bus services for JavaScript applications
.TP
.B Automatic Startup
Configured to start automatically with the desktop session
.TP
.B Background Operation
Runs silently in the background without user interface

.SH AUTOSTART CONFIGURATION
The service is configured to start automatically with the desktop environment:
.TP
.B Desktop Entry
Installed as a hidden desktop application (NoDisplay=true)
.TP
.B Startup Delay
Configured with a 15-second delay (X-MATE_Autostart-Delay=15)
.TP
.B Execution Path
/usr/bin/kysdk-dbus-websocket

.SH FILES
.TP
.B /usr/bin/kysdk-dbus-websocket
Main executable file
.TP
.B /etc/xdg/autostart/kysdk-dbus-websocket.desktop
Autostart desktop entry file
.TP
.B ~/.config/autostart/kysdk-dbus-websocket.desktop
User-specific autostart configuration (if customized)

.SH FUNCTIONALITY
.TP
.B WebSocket Server
Listens for WebSocket connections on a configured port
.TP
.B D-Bus Proxy
Forwards WebSocket requests to appropriate D-Bus services
.TP
.B Signal Broadcasting
Broadcasts D-Bus signals to connected WebSocket clients
.TP
.B JSON Protocol
Uses JSON formatting for message exchange between WebSocket clients and D-Bus services

.SH SUPPORTED INTERFACES
The service typically bridges common KYLIN SDK D-Bus interfaces including:
- System information services
- Hardware monitoring services
- Network management services
- Power management services
- Process management services

.SH NETWORK CONFIGURATION
.TP
.B WebSocket Port
Listens on a predefined port (typically configured in the application)
.TP
.B Local Access
Usually restricted to localhost connections for security
.TP
.B Protocol Support
Supports standard WebSocket protocol with JSON message format

.SH SECURITY
.TP
.B Access Restrictions
Limited to localhost connections to prevent remote exploitation
.TP
.B Privilege Level
Runs with user privileges, not system privileges
.TP
.B Interface Filtering
May implement filtering to restrict accessible D-Bus interfaces

.SH DEPENDENCIES
.TP
.B D-Bus
For communication with system services
.TP
.B WebSocket Library
For WebSocket protocol implementation
.TP
.B Desktop Environment
For autostart functionality (MATE/GNOME/KDE)

.SH MONITORING
.TP
.B Process Status
Can be monitored through standard process management tools
.TP
.B Connection Tracking
May provide connection statistics and client tracking
.TP
.B Log Output
Outputs to standard logging facilities

.SH TROUBLESHOOTING
.TP
.B Service Status
Check if the process is running with "ps aux | grep kysdk-dbus-websocket"
.TP
.B Manual Start
Can be started manually by running "/usr/bin/kysdk-dbus-websocket"
.TP
.B Log Files
Check system logs or desktop environment logs for error messages

.SH ENVIRONMENT
.TP
.B DISPLAY
Requires X11 display for desktop session integration
.TP
.B DBUS_SESSION_BUS_ADDRESS
Needs access to session D-Bus for service communication
.TP
.B HOME
Uses home directory for potential configuration files

.SH AUTHOR
KylinSoft Co., Ltd.

.SH COPYRIGHT
Copyright (C) 2023-2025, KylinSoft Co., Ltd.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

.SH SEE ALSO
.BR dbus-daemon (1),
.BR websocketd (1),
.BR ws (1)