TIC2WebSocket

Welcome to the documentation for the TIC2WebSocket project.

Introduction

TIC2WebSocket is a Java application that exposes TIC ("Téléinformation Client") data through a WebSocket interface. It allows developers to access TIC data in real time, making integrations with other systems and applications easier.

Documentation structure

The documentation is organized into several sections to guide you through using TIC2WebSocket:

• Getting Started: Quick-start guide for TIC2WebSocket.
  • Prerequisites: Required hardware and software.
  • Installation: Detailed installation instructions.
  • Launch: How to start the TIC2WebSocket server.
  • WebSocket Tester: How to use the built-in WebSocket tester.
• Usage: Common usage patterns and client-side guidance.
  • API Reference: WebSocket API documentation exposed by TIC2WebSocket.
  • Configuration: Advanced configuration details.
• Development: How to contribute to TIC2WebSocket.
  • Architecture: Project architecture overview.
  • Contributing: How to contribute code, report bugs, and propose improvements.