midas.js

function mjsonrpc_al_reset_alarm(alarms, id)

Reset alarms

RPC method: "al_reset_alarm"

mjsonrpc_al_reset_alarm(["alarm1", "alarm2"]).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of al_reset_alarm() for 1st alarm
   ... result.status[1]; // status of al_reset_alarm() for 2nd alarm
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• alarms [in] –
  Array of alarm names (array of strings)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:518

function mjsonrpc_al_trigger_alarm(name, message, xclass, condition, type, id)

Trigger an alarm

RPC method: "al_trigger_alarm"

mjsonrpc_al_trigger_alarm("Pressure", "Pressure is too high", "Alarm", "", AT_INTERNAL).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var status = rpc.result.status;  // return status of al_trigger_alarm()
   ...
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• name [in] –
  Alarm name (string)
• message [in] –
  Alarm message (string)
• xclass [in] –
  Alarm class (string)
• condition [in] –
  Alarm condition (string)
• type [in] –
  Alarm type, one of AT_xxx (integer)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:544

function mjsonrpc_call(method, params, id)

Creates a JSON-RPC request and sends it to mhttpd via HTTP POST. RPC response and error handling is done using the Javascript Promise mechanism:

mjsonrpc_call(method, params, id).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ...
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• method [in] –
  name of the RPC method (string)
• params [in] –
  parameters of the RPC method (object)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:410

function mjsonrpc_cm_exist(name, unique, id)

Check if a MIDAS program is running via cm_exist()

RPC method: "cm_exist"

mjsonrpc_cm_exist("my_program_name").then(function(rpc) {
   if (rpc.result.status == 1) {
      // Program is running
   } else if (rpc.result.status == 103) {
      // Program is not running
   } else {
      // Some unexpected error happened
   }
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• name [in] –
  Name of program to check (string)
• unique [in] –
  bUnique argument to cm_exist() (bool)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:487

function mjsonrpc_cm_msg(message, type, id)

Generate a midas message

RPC method: "cm_msg1"

mjsonrpc_cm_msg("this is a new message").then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var status = rpc.result.status;  // return status of MIDAS cm_msg1()
   ...
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• message [in] –
  Text of midas message (string)
• type [in] –
  optional message type, one of MT_xxx. Default is MT_INFO (integer)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:879

function mjsonrpc_db_copy(paths, id)

Get a copy of ODB. Symlinks are not resolved, ODB path names are not converted to lower-case.

Instead of this function, please use db_get_values() as a simple way to get easy to use ODB values.

RPC method: "db_copy"

mjsonrpc_db_copy(["/runinfo", "/equipment/foo"]).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_get_value() for /runinfo
   ... result.status[1]; // status of db_get_value() for /equipment
   var runinfo = result.data[0]; // javascript object representing the ODB runinfo structure
   var equipment = result.data[1]; // javascript object representing /equipment/foo
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:577

function mjsonrpc_db_create(paths, id)

Create ODB entries

RPC method: "db_create"

Parameters:

• paths [in] –
  Array of ODB entries to create (array of objects)
• id [in] –
  optional request id (see JSON-RPC specs) (object)
• paths[i].path [in] –
  ODB path name to create (string)
• paths[i].type [in] –
  TID_xxx data type (integer)
• paths[i].array_length [in] –
  Optional array length (default is 1) (integer)
• paths[i].string_length [in] –
  Optional string length (default is NAME_LENGTH) (integer)

Returns:

• new Promise

Defined in resources/midas.js:862

function mjsonrpc_db_delete(paths, id)

Delete ODB entries

RPC method: "db_delete"

mjsonrpc_db_delete(["/test/test1", "/test/test2"]).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_delete() for 1st path
   ... result.status[1]; // status of db_delete() for 2nd path
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:780

function mjsonrpc_db_get_value(paths, id)

Get values of ODB variables

RPC method: "db_get_value"

mjsonrpc_db_get_value("/runinfo").then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_get_value() for /runinfo
   ... result.status[1]; // status of db_get_value() for /equipment
   ... result.last_written[0]; // "last written" timestamp for /runinfo
   ... result.last_written[1]; // "last written" timestamp for /equipment
   var runinfo = result.data[0]; // javascript object representing the ODB runinfo structure
   ... runinfo["run number"];    // access the run number, note: all ODB names should be in lower-case.
   ... runinfo["run number/last_written"]; // "last_written" timestamp for the run number
   ... result.data[1].foo.variables.bar;   // access /equipment/foo/variables/bar
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:639

function mjsonrpc_db_get_values(paths, id)

Get values of ODB variables

RPC method: "db_get_values"

mjsonrpc_db_get_values(["/runinfo", "/equipment"]).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_get_value() for /runinfo
   ... result.status[1]; // status of db_get_value() for /equipment
   ... result.last_written[0]; // "last written" timestamp for /runinfo
   ... result.last_written[1]; // "last written" timestamp for /equipment
   var runinfo = result.data[0]; // javascript object representing the ODB runinfo structure
   ... runinfo["run number"];    // access the run number, note: all ODB names should be in lower-case.
   ... runinfo["run number/last_written"]; // "last_written" timestamp for the run number
   ... result.data[1].foo.variables.bar;   // access /equipment/foo/variables/bar
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:607

function mjsonrpc_db_key(paths, id)

Get ODB keys

RPC method: "db_key"

mjsonrpc_db_key(["/test/intarray1", "/test/dblarray2"]).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_get_key() for 1st path
   ... result.status[1]; // status of db_get_key() for 2nd path
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:739

function mjsonrpc_db_ls(paths, id)

Get list of contents of an ODB subdirectory, similar to odbedit command "ls -l". To get values of ODB variables, use db_get_values().

RPC method: "db_ls"

mjsonrpc_db_ls(["/alarms/alarms", "/equipment"]).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_copy_json_ls() for /alarms/alarms
   ... result.status[1]; // status of db_copy_json_ls() for /equipment
   var alarms = result.data[0]; // javascript object representing the contents of ODB /alarms/alarms
   var equipment = result.data[1]; // javascript object representing the contents of ODB /equipment
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:683

function mjsonrpc_db_paste(paths, values, id)

Write values info ODB.

RPC method: "db_paste"

mjsonrpc_db_paste(["/runinfo/run number", "/equipment/foo/settings/bar"], [123,456]).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_set_value() for /runinfo
   ... result.status[1]; // status of db_set_value() for /equipment
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• values [in] –
  Array of ODB values (array of anything)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:806

function mjsonrpc_db_resize(paths, new_lengths, id)

Change size of ODB arrays

RPC method: "db_resize"

mjsonrpc_db_resize(["/test/intarray1", "/test/dblarray2"], [10, 20]).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_set_num_values() for 1st path
   ... result.status[1]; // status of db_set_num_values() for 2nd path
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• new_lengths
• id [in] –
  optional request id (see JSON-RPC specs) (object)
• new_sizes [in] –
  Array of new sizes for each path (array of ints)

Returns:

• new Promise

Defined in resources/midas.js:711

function mjsonrpc_db_set_mode(paths, modes, id, recursive)

Set access modes for ODB keys RPC method: "db_set_mode"

Parameters:

• paths [in] –
  Array of ODB paths (array of strings)
• modes [in] –
  Array of access mode bitmaps
• id [in] –
  optional request id
• recursive [in] –
  Optional flag to include directory contents recursively (default false)

Returns:

• new Promise

Defined in resources/midas.js:765

function mjsonrpc_db_set_value(path, value, id)

Write value info ODB.

RPC method: "db_set_value"

mjsonrpc_set_value("runinfo/run number", 123).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ... result.status[0]; // status of db_set_value() for /runinfo
   ... result.status[1]; // status of db_set_value() for /equipment
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• path
• value
• id [in] –
  optional request id (see JSON-RPC specs) (object)
• paths [in] –
  Array of ODB paths (array of strings)
• values [in] –
  Array of ODB values (array of anything)

Returns:

• new Promise

Defined in resources/midas.js:834

function mjsonrpc_debug_alert(rpc)

Debug method to show RPC response

Parameters:

• rpc [in] –
  object (object), see mjsonrpc_send_request()

Returns:

• nothing

Defined in resources/midas.js:293

function mjsonrpc_decode_error(error)

Convert RPC error status to human-readable string

Parameters:

• error [in] –
  rejected promise error object (object)

Returns:

• decoded error report (string)

Defined in resources/midas.js:317

function mjsonrpc_error_alert(error, callback, param)

Handle all errors

Parameters:

• error [in] –
  rejected promise error object (object)
• callback
• param

Returns:

• nothing

Defined in resources/midas.js:369

function mjsonrpc_make_request(method, params, id)

Creates a new JSON-RPC request object

Parameters:

• method [in] –
  name of the RPC method (string)
• params [in] –
  parameters of the RPC method (object)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• the request object (object)

Defined in resources/midas.js:383

async function mjsonrpc_send_request(req)

Send JSON-RPC request(s) via HTTP POST. RPC response and error handling is done using the Javascript Promise mechanism:

var req = mjsonrpc_make_request(method, params, id);
mjsonrpc_send_request(req).then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   ...
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• req [in] –
  request object or an array of request objects (object or array of objects)

Returns:

• new Promise

Defined in resources/midas.js:153

function mjsonrpc_set_url(url)

Change the URL of JSON-RPC server

Parameters:

• url [in] –
  the new URL, i.e. "https://daqserver.example.com:8443" (string)

Returns:

• nothing

Defined in resources/midas.js:132

function mjsonrpc_start_program(name, id)

Start a MIDAS program

RPC method: "start_program"

mjsonrpc_start_program("logger").then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   var status = rpc.result.status; // return status of ss_system(), see MIDAS JSON-RPC docs
   ...
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• name [in] –
  Name of program to start, should be same as the ODB entry "/Programs/name" (string)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:435

function mjsonrpc_stop_program(name, id)

Stop a MIDAS program via cm_shutdown()

RPC method: "cm_shutdown"

mjsonrpc_stop_program("logger").then(function(rpc) {
   var req    = rpc.request; // reference to the rpc request
   var id     = rpc.id;      // rpc response id (should be same as req.id)
   var result = rpc.result;  // rpc response result
   var status = rpc.result.status; // return status of cm_shutdown(), see MIDAS JSON-RPC docs and cm_shutdown() docs
   ...
}).catch(function(error) {
   mjsonrpc_error_alert(error);
});

Parameters:

• name [in] –
  Name of program to stop (string)
• id [in] –
  optional request id (see JSON-RPC specs) (object)

Returns:

• new Promise

Defined in resources/midas.js:461

function modbset(path, value)

Simplified function to initiate an ODB write RPC request. This function returns immediately, without waiting for the request to complete. There is no way to check that the write request completed without error. Multiple calls to modbset() may result in out-of-order writes to ODB (later requests may be processed before earlier requests).

Defined in resources/midas.js:927