MR: Python Scripting

Basic Operations

The following basic operations are available for the MQTT Recorder Module and can be executed within any of the available Ignition scopes using the format system.cirruslink.recorder.operation

• createConfig(type, name, config, enabled, description)
  
  • enabled (boolean) and description (string) are optional calls
  • returns a dictionary that represents the config.json of the specified resource
• deleteConfig(type, name)
  • returns a boolean
• getConfigNames(type, enabled)
  • enabled is an optional call
  • returns a list strings
• isConfigEnabled(type, name)
  • returns a boolean
• readConfig(type, name)
  • returns a dictionary that represents the config.json of the specified resource
• setConfigEnabled(type, name, enabled)
  • returns a boolean 
• updateConfig(type, name, collisionPolicy, config)
  • returns a dictionary that represents the config.json of the specified resource

where:

• type
  • string denoting the type of configuration to operate on
• name
  • string denoting the unique name for the configuration resource to operate on
• config
  • dictionary of properties making up the configuration resource to operate on
    • general
    • table
• enabled
  • boolean
• collisionPolicy
  • string with options "MergeOverwrite" or "Overwrite"
    • "MergeOverwrite" will replace the existing properties in the resource name with only those included in the call
    • "Overwrite" will replace all properties in the resource name with those in the call

Recorder 'type' keys

• general
• table

Recorder 'general' keys

Recorder 'table' keys