You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/api_calls.rst
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,17 @@ instance, look like this::
37
37
"errors": []
38
38
}
39
39
40
+
Starting from Ultimate firmware version 3.12 it is possible to configure a
41
+
*"Network Password"*. If a non-empty password is set then most network services
42
+
of the Ultimate require the correct password to be supplied in order to be
43
+
allowed access.
44
+
45
+
For the REST API the password must be sent using an additional custom HTTP
46
+
header: ``X-Password: <your-password>``. The header must be included in all
47
+
requests to all API routes. If the header is missing or has an incorrect
48
+
password then a HTTP status code of ``403 Forbidden`` will be returned and no
49
+
further action taken. Supplying the header when no *"Network Password"* has
50
+
been set is allowed (the header will be ignored).
40
51
41
52
42
53
Routes
@@ -59,6 +70,19 @@ About
59
70
"version": "0.1",
60
71
"errors": []
61
72
}
73
+
* - ``GET /v1/info``
74
+
-
75
+
- Returns some basic information about the Ultimate device::
76
+
77
+
{
78
+
"product": "Ultimate 64",
79
+
"firmware_version": "3.12",
80
+
"fpga_version": "11F",
81
+
"core_version": "143", # Only for Ultimate 64 devices
82
+
"hostname": "Terakura",
83
+
"errors": []
84
+
}
85
+
62
86
63
87
Runners
64
88
~~~~~~~
@@ -273,6 +297,9 @@ Machine
273
297
* - ``PUT /v1/machine:poweroff``
274
298
-
275
299
- This U64-only command causes the machine to power off. Note that it is likely that you won't receive a valid response.
300
+
* - ``PUT /v1/machine:menu_button``
301
+
-
302
+
- This command does the same thing as pressing the Menu button on an 1541 Ultimate cartridge, or briefly pressing the Multi Button on the Ultimate 64. The system will either enter or exit the Ultimate menu system depending on it's current state.
0 commit comments