Skip to content

Server List Server Config

Jump to bottom
Daisuke Sato edited this page Jun 12, 2018 · 4 revisions

Server List URL

{
  servers: [{<server-1>}, {<server-2>}, ...]
}

Server object properties

Item Type Optional Description
server_id String No id for this server
available Boolean Yes item cannot be selected if false (default = true)
name {I18nStrings} No this name is shown as the title of the list item
description {I18nStrings} No this description is shown as the subtitle of the list item
hostname String No server host name
config_file_name String Yes the file name of the server config file in /config/ directory (default = server_config.json)
selected Boolean Yes Specify the default server with true (first appear)

I18nStrings object properties

{key:value, key:value, ...}

key: 2 characters language code (ISO639-1)
value: String value for the corresponding language

Example

https://hulop.github.io/serverlist.json

Server Config

{ServerConfig}

ServerConfig object properties

Conversation

NavCog shows a dialog (microphone) button on the map to enable user to talk with the agent if all the following keys are specified and the server is available.

Item Type Optional Description
conv_server String Yes hostname of the conversation server
conv_api_key String Yes api key for the conversation server

Presets

Presets files override user defaults. Specify plist file contains a dictionary.

Item Type Optional Description
preset_for_blind {FileObject} Yes preset file for blind user mode
preset_for_wheelchair {FileObject} Yes preset file for wheelchair user mode
preset_for_sighted {FileObject} Yes preset file for general pedestrian mode
map_files Array<{FileObject}> Yes an array of localization model files

FileObject properties

Item Type Description
src String path from the route
size Integer size of the file in bytes

Others

Item Type Optional Description
finger_printing_server_host String Yes the host name of the finger printing server
finger_printing_beacon_uuid String Yes UUID string of beacons to be scanned
ask_enquete Boolean Yes prompt feedback view when navigation is completed(default = false)
default_mode String Yes Specify the default user mode by user_blind or user_wheelchair or user_general

Example

http://hulop-mapservice.au-syd.mybluemix.net/config/server_config.json

Clone this wiki locally