Open Interface API

From ECCWiki

(Redirected from Open Interface)
Jump to: navigation, search

The BCS-460 uses AJAX to read and write parameters via the web browser. This is done by using the HTTP GET and POST mechanisms to access simple data files on the controller. Users can create their own applications based on this interface to link multiple controllers together, or to create custom GUIs.

Contents

[edit] Open Interface Files - Direct

These files all use the GET mechanism to read/write values, or cause direct system behavior. Usage examples are shown with BCS-460 IP address of 192.168.0.20 for demonstration, the address of your BCS-460 should be substituted.

[edit] resetcpu.dat

File Name Description Usage
resetcpu.dat Reset the controller http://192.168.0.20/resetcpu.dat

[edit] defaultcpu.dat

File Name Description Usage
defaultcpu.dat Reset the controller to defaults. All saved configuration data (structures below) will revert to initial values. http://192.168.0.20/defaultcpu.dat

[edit] resettrace.dat

File Name Description Usage
resettrace.dat Reset the datalog http://192.168.0.20/resettrace.dat

[edit] flash.bcs

File Name Description Usage
flash.bcs Put the controller into Firmware Update mode. Pass in the IP Address of the TFTP Server. Arg1=TFTP Server IP Address
http://192.168.0.20/flash.bcs?ip=192.168.0.2&

[edit] pauseit.dat

File Name Description Usage
pauseit.dat Pause or Resume a running process. Arg1=Process to pause or resume
http://192.168.0.20/pauseit.dat?proc=2&

[edit] uinputp.dat

File Name Description Usage
uinputp.dat Run or Stop a process Arg1=Process to Run/Stop
http://192.168.0.20/uinputp.dat?proc=2&

[edit] uinputw.dat

File Name Description Usage
uinputw.dat Assert a Win (Web user Input button). Wins are per process, so process number must be specified. Arg1=Process of Win
Arg2=Win identifier
http://192.168.0.20/uinputw.dat?proc=3&win=2&

[edit] uinputo.dat

File Name Description Usage
uinputo.dat Toggle an output. Output must be enabled to toggle. Arg1=Reserved
Arg2=Output
http://192.168.0.20/uinputo.dat?proc=3&out=2&

[edit] jmpstate.dat

File Name Description Usage
jmpstate.dat Jump to the specified state. Process must be running, forces an exit condition. Arg1=Process
Arg2=Jump to state
http://192.168.0.20/jmpstate.dat?proc=3&next=2&

[edit] uinputpw.dat

File Name Description Usage
uinputpw.dat Change the password. Encoded, form admin:password, password must be 8 chars or less. Arg1=Encoded password
http://192.168.0.20/uinputpw.dat?pw=hello&

[edit] alarmoff.dat

File Name Description Usage
alarmoff.dat Turn off the alarm http://192.168.0.20/alarmoff.dat

[edit] Open Interface Files - Structures

Each structure data file typically contains a comma separated list of parameters. To read the file use the GET mechanism. To write data to the controller use the POST mechanism.

Retrieved from "http://www.embeddedcontrolconcepts.com/wiki/index.php?title=Open_Interface_API"
Personal tools