kmzbrnoI / rcs-api

Specification of RCS API

RCS API v1.5 Specification

This document describes a specification of Railroad Control System Interface API. This API is used between hJOPserver and systems for controlling railroad accessories (e.g. MTB, XpressNET etc.).

---

Every railroad control system dll library should implement API described in this document to be used from hJOP.

• Functions specification
• Error codes description
• Changelog

Expected RCS workflow

1. Open – open RCS hardware, scan available modules.
2. Start – scan inputs state.
3. RCS in running.
4. Stop – stop scanning inputs.
5. Close – close connection to RCS hardware.

See also

• hJOP (in Czech)
• hJOP RCS (in Czech)
• hJOPserver (implements RCS API)
• RCS Delphi (used by hJOPserver)
• MTB direct library (implements RCS API)
• MTB v4 network library (implements RCS API)
• XpressNET RCS Library (implements RCS API)

Licence

Content of the repository is provided under Creative Commons Attribution-ShareAlike 4.0 License.

Authors

• Jan Horacek ([e-mail]) (current maintainer)
• Michal Petrilak