Skip to content

Commit 34e078c

Browse files
authored
Merge pull request #937 from cjakeman/manual-extend-api-cabcontrols
Adds missing API cab controls to Manual
2 parents 1ab6b90 + bf4a254 commit 34e078c

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed
Loading

Source/Documentation/Manual/software-platform.rst

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,11 @@ program folder and the web server defaults to ``Content\Web\index.html``.
129129

130130
If you choose to develop your own pages, please consider sharing them with the Open Rails community.
131131

132+
- The Cab Controls web page shows the controls from the cab and lets you use them to drive the player loco.
133+
134+
.. image:: images/web-page-cab-controls.png
135+
136+
132137
- The HUD web page repeats the F5 overlay.
133138

134139
.. image:: images/web-page-hud.png
@@ -149,7 +154,7 @@ If you choose to develop your own pages, please consider sharing them with the O
149154

150155
- | The Switch Panel page shows a html panel with a selection of 40 buttons. Buttons which can be used to issue Open Rails commands, normally entered via the keyboard.
151156
| This panel is most usefull when used on a touch enabled device, such as a tablet.
152-
| The adress of the panel is "<OR host>:2150/SwitchPanel/index.html", where <OR host> must be replaced with the hostname or ip adress of the host where Open Rails is running.
157+
| The address of the panel is "<OR host>:2150/SwitchPanel/index.html", where <OR host> must be replaced with the hostname or IP address of the host where Open Rails is running.
153158
| Not all buttons are yet filled. Depends also on the type of locomotive.
154159
155160
.. image:: images/switch-panel.png
@@ -193,18 +198,23 @@ Note: To avoid overloading the simulator, please keep API calls to once or twice
193198
- | ``Orts.Simulation.Physics .Train.TrainInfo``
194199
* - | GET
195200
- | ``/API/TIME``
196-
- | Retrieves just the simulation time in seconds since midnight.
197-
- | ``Orts.Viewer3D.WebServices .WebServer.ORTSApiController .ApiTime``
201+
- | Retrieves the simulation time in seconds since midnight.
202+
- | ``Orts.Viewer3D. WebServices.WebServer .ORTSApiController System.Double``
198203
* - | GET
199204
- | ``/API/MAP``
200205
- | Retrieves the postion and direction of the train.
201206
| Next to various Open Rails route data.
202-
- | ``Orts.Viewer3D.WebServices .WebServer.ORTSApiController .ApiMap``
207+
- | ``Orts.Common .LatLonDirection``
203208
* - | GET
204209
- | ``/API/CABCONTROLS``
205-
- | Retrieves an array of the cab controls for the player localhost
210+
- | Retrieves an array of the cab controls for the player loco
206211
| TypeName, MinValue, MaxValue, RangeFraction.
207-
- | ``Orts.Viewer3D.WebServices .WebServer.ORTSApiController .ApiCabControls``
212+
- | ``Orts.Viewer3D. WebServices.WebServer .ORTSApiController List<ControlValue>``
213+
* - | POST
214+
- | ``/API/CABCONTROLS``
215+
- | Sets value of a cab control for the player loco such as
216+
| Throttle/Regulator, Train Brake, Direction/Reverser.
217+
- | ``Orts.Viewer3D .WebServices.WebServer .ORTSApiController void``
208218
* - | GET
209219
- | ``/API/APISAMPLE``
210220
- | A test object that demonstrates the JSON serialization of various

0 commit comments

Comments
 (0)