Class JSON
Note any documented use of a constant is not the exclusive or sole use of the constant. Review the JSON schemas for all uses of any given constant.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int2static final String"activeProfile"static final String"add"static final String"addAndRemove"static final String"addHelpers"static final String"address"static final int16static final String"appearance"static final String"appearanceName"static final String"arrivalTime"static final String"aspect"static final String"Dark"static final String"Held"static final String"Unknown"static final String"command"static final String"None"static final String"Play"static final String"playNumLoops"static final String"Stop"static final String"identity"static final int17static final int16static final String"changeCaboose"static final String"changeEngines"static final String"client"static final int2static final String"comment"static final String"configProfile"static final String"configProfiles"static final String"conflict"static final String"Control Panel"static final String"data"static final String"decoderFamily"static final String"decoderModel"static final String"default"static final String"delete"static final String"trainDepartsName"static final String"departureTime"static final String"description"static final String"destination"static final String"direction"static final String"empties"static final String"engines"static final String"expectedArrivalTime"static final String"expectedDepartureTime"static final StringPrefix for the throttle function keys (F0-F28).static final int32static final int128static final int2static final int8static final String"forceDelete"static final String"format"static final String"formerNodes"static final String"forward"static final String"functionKeys"static final String"get"static final String"goodbye"static final int16static final String"group"static final String"heartbeat"static final String"hello"static final String"icon"static final String"iconName"static final String"id"static final String"image"static final int4static final int8static final String"int"static final String"inverted"static final String"isActiveProfile"static final String"isAutoStart"static final String"isLongAddress"static final String"isNextProfile"static final String"JMRI"static final String"json"static final StringJMRI JSON protocol version.static final String"kernel"static final String"label"static final String"Layout"static final String"length"static final String"list"static final String"lit"static final String"loads"static final String"locale"static final String"location"static final String"locations"static final String"lockable"static final int64static final String"maxSpeedPct"static final String"metadata"static final String"method"static final String"mfg"static final String"mode"static final String"model"static final String"name"static final String"networkService"static final String"networkServices"static final String"node"static final String"CV"static final String"number"static final int4static final int2static final String"mode"static final String"options"static final int48static final String"owner"static final String"panel"static final String"Panel"static final String"panels"static final String"ping"static final String"pong"static final String"port"static final String"position"static final String"post"static final String"prefix"static final String"programmer"static final String"properties"static final String"put"static final String"railroad"static final String"rate"static final String"read"static final int1static final String"remove"static final String"removeHelpers"static final String"rename"static final String"rfid"static final String"road"static final String"route"static final String"routeId"static final String"routes"static final int32static final String"schema"static final String"selectedIcon"static final String"sequenceId"static final String"server"static final String"shuntingFunction"static final String"sizeLimit"static final String"speed"static final String"state"static final int0static final int256static final String"status"static final StringNumeric status valuestatic final String"Switchboard"static final String"systemConnection"static final String"systemConnections"static final String"trainTerminatesName"static final String"throttle"static final int4static final String"time"static final int8static final String"held"static final String"total"static final String"track"static final int64static final String"trainDirection"static final String"type"static final String"uniqueId"static final String"unit"static final int0static final String"URL"static final String"userName"static final StringJSON protocol version for requesting version 5.x.y protocol.static final StringJMRI JSON protocol version 5 complete version.static final String"value"static final String"version"List of supported versions, as used in the HTTP URL paths.static final String"weight"static final String"whenLastSeen"static final String"whereLastSeen"static final String"write"static final String"xml"static final int4static final String"_jmri-json._tcp.local." Not used within the protocol, but used to support discovery of servers supporting the protocol. -
Method Summary
-
Field Details
-
V5
JSON protocol version for requesting version 5.x.y protocol. "v5"- See Also:
-
VERSIONS
List of supported versions, as used in the HTTP URL paths.Note: this being a List<String> is not stable API and is subject to change without notice.
-
V5_PROTOCOL_VERSION
JMRI JSON protocol version 5 complete version. Seejmri.server.jsonfor the version history. Starting with 5.0.0, this is a semantic version string; prior to that, it is just an X.Y version string.- See Also:
-
JSON_PROTOCOL_VERSION
JMRI JSON protocol version. Seejmri.server.jsonfor the version history. Starting with 5.0.0, this is a semantic version string; prior to that, it is just an X.Y version string.- See Also:
-
VERSION
"version"- See Also:
-
TYPE
"type"- See Also:
-
LIST
"list"- See Also:
-
DATA
"data"- See Also:
-
PING
"ping"- See Also:
-
PONG
"pong"- See Also:
-
GOODBYE
"goodbye"- See Also:
-
NAME
"name"- See Also:
-
METHOD
"method"- See Also:
-
DELETE
"delete"- See Also:
-
GET
"get"- See Also:
-
POST
"post"- See Also:
-
PUT
"put"- See Also:
-
COMMENT
"comment"- See Also:
-
USERNAME
"userName"- See Also:
-
STATE
"state"- See Also:
-
VALUE
"value"- See Also:
-
ID
"id"- See Also:
-
STATUS
"status"- See Also:
-
STATUS_CODE
Numeric status value"statusCode"
- See Also:
-
PROPERTIES
"properties"- See Also:
-
DEFAULT
"default"- See Also:
-
SPEED
"speed"- See Also:
-
DIRECTION
"direction"- See Also:
-
HELLO
"hello"- See Also:
-
JMRI
"JMRI"- See Also:
-
HEARTBEAT
"heartbeat"- See Also:
-
RAILROAD
"railroad"- See Also:
-
NODE
"node"- Since:
- 1.1
- See Also:
-
ACTIVE_PROFILE
"activeProfile"- Since:
- 3.0
- See Also:
-
FORMER_NODES
"formerNodes"- Since:
- 1.1
- See Also:
-
LOCALE
"locale"- Since:
- 1.1
- See Also:
-
ENGINES
"engines"- See Also:
-
METADATA
"metadata"- See Also:
-
PANELS
"panels"- See Also:
-
ROUTES
"routes"- See Also:
-
NETWORK_SERVICES
"networkServices"- See Also:
-
CONFIG_PROFILES
"configProfiles"- See Also:
-
CONFIG_PROFILE
"configProfile"- See Also:
-
UNIQUE_ID
"uniqueId"- See Also:
-
IS_ACTIVE_PROFILE
"isActiveProfile"- See Also:
-
IS_AUTO_START
"isAutoStart"- See Also:
-
IS_NEXT_PROFILE
"isNextProfile"- See Also:
-
NETWORK_SERVICE
"networkService"- Since:
- 2.0
- See Also:
-
PANEL
"panel"- See Also:
-
PROGRAMMER
"programmer"- See Also:
-
ROUTE
"route"- See Also:
-
THROTTLE
"throttle"- See Also:
-
ICON_NAME
"iconName"- See Also:
-
LENGTH
"length"- See Also:
-
WEIGHT
"weight"- See Also:
-
CONTROL_PANEL
"Control Panel"- See Also:
-
LAYOUT_PANEL
"Layout"- See Also:
-
SWITCHBOARD_PANEL
"Switchboard"- See Also:
-
PANEL_PANEL
"Panel"- See Also:
-
URL
"URL"- See Also:
-
FORMAT
"format"- See Also:
-
JSON
"json"- See Also:
-
XML
"xml"- See Also:
-
MODE
"mode"- See Also:
-
NODE_CV
"CV"- See Also:
-
OP
"mode"- See Also:
-
READ
"read"- See Also:
-
WRITE
"write"- See Also:
-
MODEL
"model"- See Also:
-
ROAD
"road"- See Also:
-
NUMBER
"number"- See Also:
-
IS_LONG_ADDRESS
"isLongAddress"- See Also:
-
MFG
"mfg"- See Also:
-
DECODER_MODEL
"decoderModel"- See Also:
-
DECODER_FAMILY
"decoderFamily"- See Also:
-
MAX_SPD_PCT
"maxSpeedPct"- See Also:
-
FUNCTION_KEYS
"functionKeys"- See Also:
-
IMAGE
"image"- Since:
- 2.0
- See Also:
-
ICON
"icon"- Since:
- 2.0
- See Also:
-
SELECTED_ICON
"selectedIcon"- Since:
- 2.0
- See Also:
-
LABEL
"label"- See Also:
-
LOCKABLE
"lockable"- See Also:
-
GROUP
"group"- See Also:
-
OWNER
"owner"- Since:
- 1.1
- See Also:
-
SHUNTING_FUNCTION
"shuntingFunction"- Since:
- 2.0
- See Also:
-
TRAIN_DIRECTION
"trainDirection"- See Also:
-
SEQUENCE
"sequenceId"- See Also:
-
ARRIVAL_TIME
"arrivalTime"- Since:
- 1.1
- See Also:
-
EXPECTED_ARRIVAL
"expectedArrivalTime"- See Also:
-
EXPECTED_DEPARTURE
"expectedDepartureTime"- See Also:
-
DEPARTURE_TIME
"departureTime"- See Also:
-
DEPARTURE_LOCATION
"trainDepartsName"- See Also:
-
TERMINATES_LOCATION
"trainTerminatesName"- See Also:
-
DESCRIPTION
"description"- See Also:
-
ROUTE_ID
"routeId"- See Also:
-
KERNEL
"kernel"- Since:
- 1.1
- See Also:
-
LOCATIONS
"locations"- See Also:
-
LOCATION
"location"- See Also:
-
TRACK
"track"- Since:
- 1.1
- See Also:
-
DESTINATION
"destination"- See Also:
-
ADD_HELPERS
"addHelpers"- Since:
- 1.1
- See Also:
-
CHANGE_CABOOSE
"changeCaboose"- Since:
- 1.1
- See Also:
-
CHANGE_ENGINES
"changeEngines"- Since:
- 1.1
- See Also:
-
REMOVE_HELPERS
"removeHelpers"- Since:
- 1.1
- See Also:
-
OPTIONS
"options"- Since:
- 1.1
- See Also:
-
ADD
"add"As an attribute of a
JsonRoster.ROSTER, this is an entry that has been added to the roster.- Since:
- 1.1
- See Also:
-
REMOVE
"remove"In operations, this indicates the dropping or setting out of a car or engine.
As an attribute of a
JsonRoster.ROSTER, this is an entry that has been removed from the roster.- Since:
- 1.1
- See Also:
-
ADD_AND_REMOVE
"addAndRemove"- Since:
- 1.1
- See Also:
-
TOTAL
"total"- Since:
- 1.1
- See Also:
-
LOADS
"loads"- Since:
- 1.1
- See Also:
-
EMPTIES
"empties"- Since:
- 1.1
- See Also:
-
APPEARANCE
"appearance"- See Also:
-
APPEARANCE_NAME
"appearanceName"- See Also:
-
ASPECT
"aspect"- See Also:
-
ASPECT_DARK
"Dark"- See Also:
-
ASPECT_HELD
"Held"- See Also:
-
ASPECT_UNKNOWN
"Unknown"- See Also:
-
TOKEN_HELD
"held"- See Also:
-
LIT
"lit"- See Also:
-
ADDRESS
"address"- See Also:
-
FORWARD
"forward"- See Also:
-
F
Prefix for the throttle function keys (F0-F28)."F"
- See Also:
-
INVERTED
"inverted"- See Also:
-
INTEGER
"int"- See Also:
-
PORT
"port"- See Also:
-
POSITION
"position"- See Also:
-
SIZE_LIMIT
"sizeLimit"- See Also:
-
RATE
"rate"- See Also:
-
AUDIO_ICON_IDENTITY
"identity"- See Also:
-
AUDIO_COMMAND
"command"- See Also:
-
AUDIO_COMMAND_NONE
"None"- See Also:
-
AUDIO_COMMAND_PLAY
"Play"- See Also:
-
AUDIO_COMMAND_PLAY_NUM_LOOPS
"playNumLoops"- See Also:
-
AUDIO_COMMAND_STOP
"Stop"- See Also:
-
UNKNOWN
0Note that this value deliberately differs from
NamedBean.UNKNOWNso that JSON clients can treat all known states as true, and the unknown state as false.- See Also:
-
ON
2- See Also:
-
OFF
4- See Also:
-
INCONSISTENT
8- See Also:
-
AUDIO_PLAYING
17- See Also:
-
AUDIO_STOPPED
16- See Also:
-
TOGGLE
8- See Also:
-
ACTIVE
2- See Also:
-
INACTIVE
4- See Also:
-
STATE_DARK
0- See Also:
-
RED
1- See Also:
-
FLASHRED
2- See Also:
-
YELLOW
4- See Also:
-
FLASHYELLOW
8- See Also:
-
GREEN
16- See Also:
-
FLASHGREEN
32- See Also:
-
LUNAR
64- See Also:
-
FLASHLUNAR
128- See Also:
-
STATE_HELD
256- See Also:
-
CLOSED
2- See Also:
-
THROWN
4- See Also:
-
ALLOCATED
16- See Also:
-
RUNNING
32- See Also:
-
OUT_OF_SERVICE
48- See Also:
-
TRACK_ERROR
64- See Also:
-
UNIT
"unit"- Since:
- 1.1
- See Also:
-
PREFIX
"prefix"- Since:
- 2.0
- See Also:
-
SYSTEM_CONNECTION
"systemConnection"- Since:
- 2.0
- See Also:
-
SYSTEM_CONNECTIONS
"systemConnections"- Since:
- 2.0
- See Also:
-
SCHEMA
"schema"- Since:
- 4.1
- See Also:
-
SERVER
"server"- Since:
- 4.1
- See Also:
-
CLIENT
"client"- Since:
- 4.1
- See Also:
-
FORCE_DELETE
"forceDelete"- Since:
- 5.0.0
- See Also:
-
CONFLICT
"conflict"- Since:
- 5.0.0
- See Also:
-
RENAME
"rename"In a message from a client, carries the new name for the object in the message; note that some services may bar changing the name of an object, while other services will change the name based on other values. In a message from the server, carries the old name for a recently renamed object in the message.
- Since:
- 5.0.0
- See Also:
-
RFID
"rfid"- Since:
- 5.0.0
- See Also:
-
WHERELASTSEEN
"whereLastSeen"- Since:
- 5.7.6
- See Also:
-
WHENLASTSEEN
"whenLastSeen"- Since:
- 5.7.6
- See Also:
-
TIME
"time"- Since:
- 5.0.0
- See Also:
-
ZEROCONF_SERVICE_TYPE
"_jmri-json._tcp.local." Not used within the protocol, but used to support discovery of servers supporting the protocol.- See Also:
-