ОписаниеЦели и преимуществаАрхитектураРепозиторий модулейHTTP APIДокументацияДорожная карта (MVP)Демонстрация (видео)Загрузки
XORDE at GitHub  XORDE on YouTube

© 2018—2021 МФТИ
Лаборатория Нейророботехники

HTTP API

Операционная среда запускает исполнительный веб-сервер по протоколу http, позволяющий получать полную информацию о составе (модулях и компонентах), функционал создания, получения, сохранения, удаления и запуска схем.

Для обращения к серверу на том же компьютере следует использовать обращение адресу http://127.0.0.1:17080. Для обращения через другой компьютер в локальной сети следует использовать IP-адрес компьютера, на котором запущена операционная среда с портом 17080. Например, http://172.16.0.200:17080.

Запросы регистро-независимые. Результатом исполнения будет ответ в формате json, с минимальным статусом {“result”:true/false} и опциональными дополнительными полями в зависимости от сущности запроса.

Запросы вызываются путем добавления к url вида http://XXX.XX.XX.XXX:17080.
Например, http://127.0.0.1/?action=getConfig.

Get-параметры записаваются после параметра "action" c разделителем "&".
Например, http://127.0.0.1/?action=getScheme&name=TestScheme

Post-параметры пишутся в тело запроса, "content=XXXXX"

Список запросов

getConfig

Get all available modules and their components

Returns
configAn array of module names with an array of related component names

getComponentSetting

Gets a setting value from an existing component in current scheme

GET params
componentNameName of the component
settingNameSetting name
Returns
valueValue of the setting

setComponentSetting

Sets a setting value in an existing component in current scheme

GET params
componentNameName of the component
settingNameSetting name
valueValue of the setting

schemeStatus

Return the current state of XORDE

Returns
currentSchemeScheme name (if any scheme is current)
isRunningTrue if scheme is activated (started)

getSchemes

Get list of existing schemes

Returns
listArray of scheme names

getScheme

Get scheme file contents

GET params
nameScheme name
Returns
schemeScheme contents in JSON format

deleteScheme

Deletes scheme file

GET params
nameScheme name

getComponentOutput

Gets output value of an existing component in current scheme

GET params
componentNameName of the component
outputOutput name
Returns
valueValue of the output

saveScheme

Sets scheme file content. (Reloads the scheme if it is current)

GET params
nameScheme name (can be either existing or a new one)
POST params
contentScheme in JSON format packed in utf8 base64 string. (See b64EncodeUnicode(str) at https://developer.mozilla.org/ru/docs/Web/API/WindowBase64/Base64_encoding_and_decoding )

setCurrentScheme

Sets current scheme from provided scheme name

GET params
nameScheme name

runjs

Runs a JavaScript code in xoCore (similar to the JavaScript console in GUI)

POST params
contentJS-code packed in utf8 base64 string. (See b64EncodeUnicode(str) at https://developer.mozilla.org/ru/docs/Web/API/WindowBase64/Base64_encoding_and_decoding )
Returns
answerResult of JS-code operation

createComponent

Creates component in current scheme

GET params
componentComponent type name to create
moduleParent module name

startScheme

Sets current scheme and activates (starts) it

GET params
nameScheme name

stopScheme

Deactivates (stops) current scheme (if any scheme is current)


help

Returns an html help page about available xoWebServer requests