Medialon MxMs' Help 
  
Name : Medialon Variables Management
Version : 1.1.1
Available for: Manager V5 (all versions), Showmaster (all versions)
Limitation In:
Device Brand: Medialon
Positrack Compatible: Yes
Resources type: None
 
Compatible hardware interfaces - available resource modules (MRC):
 

 

> Overview | > Installation (MXM) | > Creation (Device) | > Commands (List Of) | > Variables (List Of) | > Support


Overview:

This mxm provides commands that act on variables, and these commands are positracked when they are used
into a Medialon Manager timeline.

The first five commands, "Set Integer", "Set String", "Set Time", "Set Enum" and "Set Date" are simple positracked assigments.
The commands "Start Timer"/"Stop timer" manage accurate timers on Time variables.
The commands "Start Counter"/"Stop Counter" manage accurate counters on Integer variables.

> Top


Installation (MXM):

No specific installation required.

> Top


Creation (Device):

No device creation window.

> Top


Commands (List Of):

Set integer:

      Description: to set the value of an integer variable.
      Parameters:
        Integer variable: [Type: Integer]: Variable to set
        Value : [Type: Integer]: New value.

Set string:

    Description: to set the value of a string variable.
    Parameters:

    String variable: [Type: String]: Variable to set
    Value : [Type: String]: New value.

Set time:

    Description: to set the value of a time variable.
    Parameters:

    Time variable: [Type: Time]: Variable to set
    Value : [Type: Time]: New value.

Set enum:

    Description: to set the value of an enum variable.
    Parameters:

    Integer variable: [Type: Enum]: Variable to set
    Index : [Type: Integer]: New current index.

Set date:

    Description: to set the value of an date variable.
    Parameters:

    Date variable: [Type: Date]: Variable to set
    Value : [Type: Date]: New value.

Set real:

    Description: to set the value of a real variable.
    Parameters:

    Real variable: [Type: Real]: Variable to set
    Value : [Type: Real]: New value.

Start timer:

    Description: to start a timer on a Time variable.
    Parameters:

    Time variable: [Type: Time]: Variable to set.
    Initial Value: [Type: Time]: Initial value of the variable.

    Final Value: [Type: Time]: Value to reach.

    Start from: [Type: Enum]: Defines the value to start from.

         Available Values:
         -
    "Initial value": The variable is first filled with the initial value      passed as 2nd parameter before the timer runs.
         - "Current value": The initial value passed as 2nd parameter is      ignored.

Stop timer:

    Description: to stop a timer on a Time variable.
    Parameters:

    Time variable: [Type: Time]: Variable for which stop the timer.

Start counter:

    Description: to start a counter on an Integer variable.
    Parameters:

    Integer variable: [Type: Integer]: Variable to set.
    Initial Value: [Type: Integer]: Initial value of the variable.

    Final Value: [Type: Integer]: Value to reach.

    Incremental Value: [Type: Integer]: Value to add to the current value (can be negative).

    Time Interval/Duration: [Type: Time]: Time between each incrementation ( period of the counter ) if "Time mode" is on "Use interval", total duration if "Time mode" is on "Use duration".

    Start from: [Type: Enum]: Defines the value to start from.

         Available Values:
         -
    "Initial value": The variable is first filled with the initial value      passed as 2nd parameter before the timer runs.
         - "Current value": The initial value passed as 2nd parameter is      ignored.
    Time mode: [Type: Enum]: Defines time parameter.

         Available Values:
         -
    "Use interval": the parameter "Time Interval/Duration" is an      interval (period of the counter).
         -
    "Use duration": the parameter "Time Interval/Duration" is a      duration (total time).
    Usage: the parameters of the counters can also be variables affected by other commands: it is so possible to create sophisticated periodic changes, like special curves or accelerations, for example.

Stop counter:

    Description: to stop a counter on an Integer variable.
    Parameters:

    Integer variable: [Type: Integer]: Variable for which stop the counter.

Real to ASCII:

    Description: Convert a real value into an ASCII string (IEEE-754 standard is used). Returned String is compliant with Low Level Communicator MXM byte format.
    Parameters:

    String variable: [Type: String]: String variable which returns the ASCII value.
    Real Value: [Type: Real]: Real value to convert.

    Hex Coded ASCII: [Type: Enum]: Defines the form of the returned ASCII value.
         Available Values:
         -
    "No": The returned ASCII value is in Hex format not converted into ASCII value. An hex value of 3C will be returned as !3C.
         - "Yes": The returned ASCII value is in Hex format converted into ASCII value. An hex value of 3C will be returned as !33 !3C.

    Note: Using this command doesn't cause the String variable to be positracked. In such cases, Set String command must be used.

ASCII to Real:

    Description: Convert an ASCII string value into a real value(IEEE-754 standard is used). Passed string must be compliant with Low Level Communicator MXM byte format ('!XX' is used to express XX hex value).
    Parameters:

    Real variable: [Type: Real]: Real variable which returns the real value.
    ASCII Value: [Type: String]: String value to convert.

    Note: The command will automatically detect if the ASCII string is "Hex Coded ASCII" formatted (i.e a value of 4C is expressed as !34!3C) or not (i.e a value of 4C is expressed as !4C).

    Note 2: Using this command doesn't cause the Real variable to be positracked. In such cases, Set Real command must be used.

     

Start Record:

    Description: Starts to record the given variable into a file.
    Parameters:

    Variable Name: [Type: String]: Name of the variable to record. The name must match an existing variable name.
    File Name: [Type: String]: File name to record into.

    Note: Any class of variable can be recorded. The record continue until a Stop Record command is issued for the variable.

     

Stop Record:

    Description: Stops the record for the given variable.
    Parameters:

    Variable Name: [Type: String]: Name of the variable for which the record has to be stopped. The name must match an existing variable name.

     

Start Playback:

    Description: Starts to playback the given variable from a file.
    Parameters:

    Variable Name: [Type: String]: Name of the variable to playback. The name must match an existing variable name.
    File Name: [Type: String]: File name to playback.

    Note: Only User and Screen class of variable can be playback. The playback ends when there is no more data to playback into the file or when a Stop Playback command is issued.

     

Stop Playback:

    Description: Stops the playback for the given variable.
    Parameters:

    Variable Name: [Type: String]: Name of the variable for which the playback has to be stopped. The name must match an existing variable name.

     

> Top


Variables (List Of):

Status:

      Type: Enum.
      Description: Current device status.
      Available Values:
        "Iddle": The device is stopped.
        "Ready": The device is ready.
Error:
      Type: Enum.
      Description: Current error status.
      Available Values:
        "No Error": There is no error.
        "No Variable": The variable name passed to the command doesn't match an existing variable.
        "Invalid Param": One of the parameter is invalid.
        "File Access Error": Recording or Playback cannot access the data file.
        "Invalid File": The data file is invalid, playback is not possible.

> Top


Support (Difference with previous versions):

V 1.0.1:

  • Added: Support for Showmaster.

V 1.0.2:

  • Internal Changes.
  • Fixed : "Start Timer" and "Stop Timer" crash if parameter "Time" is not a time variable.

V 1.0.3:

  • Fixed : "Start Timer" is not correctly positracked.

V 1.0.4:

  • Added: Support for Showmaster Pro.

V 1.1.0:

  • Added: Support for Variable record feature.
  • Added: "Start Record", "Stop Record", "Start Playback", "Stop Playback" commands.

V 1.1.1:

  • Added: Support for Showmaster iPro.

> Top