Filters
Filter values by
System Settings
  • Timer and counter settings
  • Digital I/O settings
  • Hardware resources available
  • Rotary decoder settings
  • Data latch settings
  • Action group settings
  • Thread and timeout settings
  • Trigger-over-Ethernet settings
  • UART settings
  • Watchdog settings
| Customize Help
| Save Settings

MsysControl



Function Map
Parameter Associations
Table: For general system settings
+ combination: For specifying which connector or port to control
+ combination: For specifying which configuration information file to access
+ combination: For specifying whether Matrox Feature Browser should be synchronous or asynchronous
+ combination: For specifying the number of hook threads
Table: For routing I/O signals and setting their mode
+ combination: For specifying the type and number of the I/O signal to affect
Table: For setting the state of specified user-bits in a static-user-output register
+ combination: For specifying the bit in a static-user-output register to affect
Table: For controlling the settings of a timer
+ combination: For specifying which on-board timer to control
Table: For controlling the settings of a rotary decoder
+ combination: For specifying which rotary decoder to set
Table: For controlling the settings of a data latch associated with rotary encoders
+ combination: For specifying which data latch to set
Table: For UART settings
+ combination: For specifying which UART to control
Table: For Watchdog settings
Table: For configuring and sending an action command to a GigE Vision camera
Table: For specifying a Trigger-over-Ethernet packet (action command or GigE Vision software trigger) for transmission using a ToE module
+ combination: For specifying which action command to control
+ combination: For specifying which GigE Vision software trigger to control
+ combination: For specifying which I/O command register bit to use
Synopsis
Control a system setting.
Syntax
void MsysControl(
MIL_ID SysId, //in
MIL_INT64 ControlType, //in
MIL_DOUBLE ControlValue //in
)
Description

This function allows you to control the specified system setting.

Note that, when a control type has only one supported control value on a given system, it is not documented in this function because it cannot be changed to another value. Instead, it can only be inquired.

To inquire the current value of a particular system setting, use MsysInquire().

You can also interactively control and test most of the system settings in real-time, using Matrox Intellicam's Feature Browser.

Note that when using a C compiler (not a C++ or other compiler), it is suggested to use the type-specific versions of this particular function, rather than the standard function prototype at the top of this page. An exhaustive list of type-specific versions of this function can be found at the bottom of this page.
Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
SysId

Specifies the system identifier. This parameter should be set to one of the following values:

function map For the system identifier
Click to summarizeValue Description
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.

Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

ControlType

Specifies the type of setting to control.

See the Parameter associations section for possible values that can be specified.

ControlValue

Specifies the new value to assign to the system setting specified by the ControlType parameter.

See the Parameter associations section for possible values that can be specified.

The following control types allow you to control the general system settings.

function map For general system settings
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_ALLOCATION_OVERSCAN

Sets whether image buffers, allocated on the system, are allocated by default with an overscan region. Specify the size of the overscan region using M_ALLOCATION_OVERSCAN_SIZE.

Note that you can override this setting when allocating a buffer using the M_ALLOCATION_OVERSCAN attribute. INQ

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_DEFAULT

Same as M_ENABLE.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_DISABLE

Specifies that image buffers allocated on the system will have no overscan region.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_ENABLE

Specifies that image buffers are allocated on the system with an overscan region.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_ALLOCATION_OVERSCAN_SIZE

Sets the size of the overscan region, added around all subsequently allocated image buffers (MbufAlloc...()). The overscan settings previously allocated image buffers are not changed. For more information, see the Buffer overscan region section of Chapter 21: Data buffers.

To enable or disable the allocation of an overscan region, change the setting of M_ALLOCATION_OVERSCAN. INQ

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_DEFAULT

Specifies the default size of the overscan region.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
MIL system specific

The default size is 8 pixels.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the size of the overscan region, in pixels. For example, if you specify a size of 2, a 2-pixel overscan border is added around subsequently allocated image buffers.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_DEFAULT_PITCH_BYTE_MULTIPLE

Sets the pitch (or stride) multiple (in bytes) for the buffers allocated on the system. The pitch is the number of bytes between the beginnings of any two adjacent rows of the buffer's data. The pitch multiple is the factor by which the pitch of a buffer must be divisible. When a buffer is allocated, if the specified width is not a multiple of this value, padding is added to the buffer so that the buffer's pitch meets this constraint. You would typically change this value when you need to reduce the padding of your buffer.

Note that, allocating a buffer with an overscan region can also be a cause of buffer padding. For more information, refer to M_ALLOCATION_OVERSCAN and the Accessing a MIL buffer directly section of Chapter 21: Data buffers.

When dealing with an on-board operation, changing the pitch multiple might force on-board operations to be performed off-board due to hardware limitations, thereby increasing the amount of time the operation might take. INQ

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_DEFAULT

Specifies the default value for the pitch multiple. The default value is highly MIL system-dependent. Always inquire the current pitch multiple before setting it, using MsysInquire() with M_DEFAULT_PITCH_BYTE_MULTIPLE.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize Value

Specifies the pitch multiple, in bytes.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_DEVICE_NAME

Sets a user-defined name for the board. The user-defined name is written to the board, making it persistent, and allows the board to be allocated using this user-defined name in the future. The name is typically assigned and written to the board from a separate executable that allocates a system for the board with M_DEVn and then calls MsysControl() with the control type (M_DEVICE_NAME).

This control type is also available for the Matrox Concord PoE base model.

(summarize)
z
Click to summarize
M_PTR_TO_DOUBLE(
MIL_CONST_TEXT_PTR String
)

Casts the address of the string specifying the board's name, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE.

(summarize)
z
Parameters

This parameter specifies the string to cast.

z
DeviceName

Specifies the name of the board. Note that this must be a unique name with a string that can be up to M_DEVICE_NAME_MAX_SIZE characters.

z
Click to summarize M_GC_FEATURE_BROWSER +
[This is only applicable to Windows]

Sets whether to open or close a dialog box that allows you to view and edit the GenTL SFNC-compliant system and interface configuration information interactively, using Matrox Feature Browser.

(summarize)
v
Click to summarize M_DEFAULT

Same as M_OPEN.

v
Click to summarize M_CLOSE

Closes Matrox Feature Browser.

v
Click to summarize M_OPEN +

Opens Matrox Feature Browser.


You must specify a combination value from the following table:
(summarize)
v
Click to summarize M_GC_FEATURE_EXECUTE_POLLING_MODE

Sets whether the executable feature is executed synchronously or asynchronously. INQ

(summarize)
c
U25
v
Click to summarize M_DEFAULT

Same as M_MANUAL.

c
U25
v
Click to summarize M_AUTOMATIC

Specifies that the specific executable camera feature is executed synchronously.

When in automatic mode, the executable feature is executed synchronously. MIL polls the feature to establish if the executable feature has completed, returning control only when the operation is complete. Get the polling interval using M...InquireFeature() with M_FEATURE_POLLING_INTERVAL.

(summarize)
c
U25
v
Click to summarize M_MANUAL

Specifies that the executable camera feature is executed asynchronously.

When in manual mode, the executable feature is executed asynchronously, and control is returned once the executable operation begins. To determine whether the executable feature completed, use M...InquireFeature() with M_FEATURE_EXECUTE_COMPLETED.

(summarize)
c
U25
v
Click to summarize M_LED_USER

Sets the color of the user LED on your Matrox Iris GTR. INQ

(summarize)
t
U28
Click to summarize M_DEFAULT

Same as M_OFF.

t
U28
Click to summarize M_GREEN

Specifies to turn the user LED green.

t
U28
Click to summarize M_OFF

Specifies to turn the user LED off.

t
U28
Click to summarize M_ORANGE

Specifies to turn the user LED orange.

t
U28
Click to summarize M_RED

Specifies to turn the user LED red.

t
U28
Click to summarize M_MODIFIED_BUFFER_HOOK_MODE

Sets whether to run user-defined functions hooked to a buffer modification on separate threads, up to the number of CPU cores present in the computer. This is particularly useful when functions are hooked using MdigProcess(). INQ

(summarize)
c
M10
g h i j k
M10
l m o p r
U27
u
U36
v y
U75
aa
Click to summarize M_DEFAULT

Same as M_SINGLE_THREAD.

c
M10
g h i j k
M10
l m o p r
U27
u
U36
v y
U75
aa
Click to summarize M_MULTI_THREAD +

Specifies to run user-defined functions hooked to a buffer modification on separate threads. The hooked functions are executed by any available CPU core. MIL cannot guarantee the processing order of any image on such a computer, because they are executed concurrently. If required, use Microsoft Windows functions to synchronize the threads.

Note that by default, this control value will allocate, as necessary, up to 16 threads, or the total number of CPU cores in the computer, whichever is least.

(summarize)
c
M10
g h i j k
M10
l m o p r
U27
u
U36
v y
U75
aa
Click to summarize M_SINGLE_THREAD

Specifies that only one thread should be created and that all user-defined functions hooked to buffer modifications are run on the same thread.

c
M10
g h i j k
M10
l m o p r
U27
u
U36
v y
U75
aa
Click to summarize M_POWER_OVER_CABLE +

Sets whether the board provides power to connected devices. INQ

(summarize)
a y
U84
z
MIL system specific

You must specify a combination value from the following table:
a y
U75

For a Host system, this sets whether PoE (Power over Ethernet) is enabled on the specified port.

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm or EV6.

On a Matrox 4Sight GPm or EV6 platform, this value is only available if MIL 10 update 86 (or later) is installed. It is not available on a Matrox 4Sight GP.

a

For Matrox Concorde POE, this sets whether PoE (Power over Ethernet) is enabled on all ports.

This control type is also available for the Matrox Concord PoE base model.

z

For Matrox Rapixo CXP, this sets whether PoCXP (Power over CXP) is automatically enabled when a PoCXP-compliant camera is connected to the specified connector.

y
U84
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
a y
U84
z
MIL system specific

For Matrox 4sight GPm and EV6, the default value is set in the UEFI.

On legacy computers, this was referred to as a BIOS.

a

For Matrox Concorde POE, this is the same as M_ON.

z

For Matrox Rapixo CXP, this is the same as M_AUTOMATIC.

y
U84
Click to summarize M_AUTOMATIC

Specifies to automatically enable or disable PoCXP on this CXP connector, depending on detected device support.

y
U84
Click to summarize M_OFF

Specifies not to provide power to connected devices.

(summarize)
a y
U84
z
MIL system specific

For Matrox 4sight GPm and EV6, this specifies to disable PoE on the specified port.

a

For Matrox Concorde POE, this specifies to disable PoE on all ports.

z

For Matrox Rapixo CXP, this specifies to manually disable PoCXP on the specified CXP connector.

y
U84
Click to summarize M_ON

Specifies to provide power to connected devices.

(summarize)
a y
U84
z
MIL system specific

For Matrox 4sight GPm and EV6, this specifies to enable PoE on the specified port.

a

For Matrox Concorde POE, this specifies to enable PoE on all ports.

z

For Matrox Rapixo CXP, this specifies to manually disable PoCXP on the specified CXP connector.

You should typically use the default setting (M_AUTOMATIC) which specifies to automatically detect whether the connected camera supports PoCXP. If you manually enable PoCXP and connect a device that is not fully CXP-compliant, the device might be damaged.

y
U84
Click to summarize M_RESET

Specifies to reset an over- or under-current condition. To learn whether there is an over- or under-current condition, use MsysInquire() with M_POWER_OVER_CABLE_STATUS.

Typically, to prevent the over- or under-current condition from immediately recurring, you should first restart PoCXP for this connector by setting this control type to M_OFF and then returning it to its previous setting (M_AUTOMATIC is recommended). If the condition persists, discontinue using PoCXP with your camera by leaving this control type set to M_OFF.

(summarize)
y
U84
Click to summarize M_THREAD_MODE

Sets whether threads allocated on the system can execute in asynchronous mode.

If you specify that threads on the system can execute in asynchronous mode, the MthrControl() M_THREAD_MODE control type setting of each of its threads is taken into account; otherwise, their M_THREAD_MODE control type setting is ignored. INQ

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
MIL system specific

This inquire type is also available for the Matrox Concord PoE base model.

z
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
MIL system specific

Same as M_ASYNCHRONOUS.

c
M10
g h i j k
M10
l m o p r
U27
u
U36
v y
U75
aa

Same as M_SYNCHRONOUS.

a t
U28
Click to summarize M_ASYNCHRONOUS

Specifies that threads allocated on the system can execute in asynchronous mode. In asynchronous mode, control is returned to the Host immediately after a MIL function is sent to the processor of the system (when the system and function allow an immediate return).

(summarize)
c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SYNCHRONOUS

Specifies that threads allocated on the system can only execute in synchronous mode. In synchronous mode, the execution of a MIL function sent to the processor of a system must be completed (execution terminated) before returning control to the Host.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_TIMEOUT

Sets the maximum amount of time for the Host to wait for a synchronous function to return before generating a time-out error, in sec.

Note that this value only works with functions that are performed on-board, such as MbufCopy() when copying from (or to) on-board memory or functions using an on-board processing FPGA. INQ

(summarize)
c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
z aa
MIL system specific

This inquire type is also available for the Matrox Concord PoE base model.

z
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
z aa
MIL system specific

The default value is 20 sec.

c
M10
g h i j k
M10
m o p r
U27
t
U28
u
U36
v y
U75
aa

Same as M_INFINITE.

l
Click to summarize M_INFINITE

Waits indefinitely.

l t
U28
Click to summarize Value

Specifies the time to wait, in sec.

c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
z aa
Combination values for M_POWER_OVER_CABLE.

You must add one of the following values to the above-mentioned value to specify which connector or port to control.

function map For specifying which connector or port to control
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_ALL

Specifies to control all relevant connectors or ports on your board or industrial computer.

a y
U84
Click to summarize M_CONNECTIONn

Specifies to control connector n, where n corresponds to a physical connector or port on your board or industrial computer.

(summarize)
a y
U84
MIL system specific

For a Matrox 4sight GPm and EV6, n can be a value from 1 to 4, depending on the number of PoE-enabled Ethernet ports on the version of your industrial computer.

a

For Matrox Rapixo CXP, n can be a value from 0 to 3, depending on the number of CXP connectors on the version of your board.

y
U84
Combination values for M_GC_FEATURE_BROWSER.

You can add one of the following values to the above-mentioned value to specify which instance of the GenTL interface configuration file (XML file) is associated with the feature.

function map For specifying which configuration information file to access
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize

Specifies which instance of the GenTL interface configuration file is associated with the feature.

(summarize)
v
Parameters

Specifies the index of the GenTL interface configuration file.

v
0 <= Value <=
MsysInquire(M_GENTL_INTERFACE_COUNT)

Specifies the index.

v
Click to summarize M_GENTL_SYSTEM

Specifies to display the GenTL system configuration information.

v
Combination values for M_OPEN (when ControlType=M_GC_FEATURE_BROWSER and ControlValue=M_OPEN).

You must add one of the following values to the above-mentioned value to set whether the Feature Browser should be synchronous or asynchronous.

function map For specifying whether Matrox Feature Browser should be synchronous or asynchronous
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_ASYNCHRONOUS

Specifies that this function returns immediately once Matrox feature browser window opens.

v
Click to summarize M_SYNCHRONOUS

Specifies that this function is blocked until Matrox feature browser window closes.

v
Combination value for M_MULTI_THREAD (when ControlType=M_MODIFIED_BUFFER_HOOK_MODE and ControlValue=M_MULTI_THREAD).

You can add the following value to the above-mentioned value to set the number of hook threads to allocate.

function map For specifying the number of hook threads
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize Value >= 1

Specifies the number of hook threads to allocate. Note that this value cannot exceed the number of CPU cores available.

(summarize)
c
M10
g h j k
M10
l m o p r
U27
v y
U75
aa

The following control types allow you to set the mode and the routing of your Matrox imaging board's I/O signals (such as, auxiliary signal). Once the routing and mode are determined for an I/O signal, the MIL function that you should use to act upon an input signal or setup the source of an output signal depends on the functionality. For example, you can use MsysControl() with M_USER_BIT... control types, MdigControl() with M_GRAB_TRIGGER... control types, or MdigControl() with M_TIMER... control types.

Note that for other Matrox imaging boards that have auxiliary I/O signals, but are not supported with the constants below, see MdigControl().

Each Matrox imaging board and MIL driver has its own list of limitations regarding the signals you can control with this function. While general limitations are listed in the table below, for a complete list of the available signals and their limitations, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

function map For routing I/O signals and setting their mode
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_IO_DEBOUNCE_TIME +

Sets the amount of time that the specified auxiliary input signal is debounced. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

When a signal is debounced on Matrox 4Sight GPm, after detecting a valid input signal edge any other transitions are considered noise and are suppressed for the specified time, to ignore any additional transitions caused by the contact bounce of mechanical switches.

a

When a signal is debounced on Matrox Iris GTR, after detecting a valid input signal edge any other transitions are considered noise and are suppressed for the specified time, to ignore any additional transitions caused by the contact bounce of mechanical switches. To remove problems occurring at the edge of a signal, use M_IO_GLITCH_FILTER_STATE.

t
U28
Click to summarize Value >= 0

Specifies the minimum amount of time to ignore any additional signal transitions after accepting a signal transition, in nsec.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

In the case of Matrox 4Sight GPm (Ivy Bridge), the maximum value is 503316450. Note that the number must be a multiple of 30.

In the case of Matrox 4Sight GPm (Bay Trail), the maximum value is 671088600. Note that the number must be a multiple of 40.

a

In the case of Matrox Iris GTR, the maximum value is 268435440. Note that the number must be a multiple of 16.

t
U28
Click to summarize M_IO_GLITCH_FILTER_STATE +

Sets whether to enable a glitch filter on input signals. A glitch is an unexpected signal transition of a short duration. Enabling the glitch filter will eliminate glitches of less than 500 nsec on all input signals. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_DEFAULT

Same as M_DISABLE.

a t
U28
w
U53
z
Click to summarize M_DISABLE

Specifies not to use a glitch filter.

a t
U28
w
U53
z
Click to summarize M_ENABLE

Specifies to use a glitch filter.

a t
U28
w
U53
z
Click to summarize M_IO_INTERRUPT_ACTIVATION +

Sets the signal transition upon which to generate an interrupt, if interrupt generation has been enabled for the specified I/O signal. Use M_IO_INTERRUPT_STATE to enable interrupt generation.

Note that this only applies to input signals.

Note that this control type only has an effect when M_IO_INTERRUPT_STATE is enabled. INQ


You must specify a combination value from the following table:
(summarize)
a g h t
U28
w
U53
z
MIL system specific

This control type is only available with auxiliary I/O signals 3-6.

t
U28
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight.

a
Click to summarize M_DEFAULT

Same as M_EDGE_RISING.

a g h t
U28
w
U53
z
Click to summarize M_ANY_EDGE

Specifies to generate an interrupt upon both a low-to-high and a high-to-low signal transition.

(summarize)
a t
U68
w
U68
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight GPm or EV6.

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 68 (or later) is installed. It is not available on a Matrox 4Sight GP.

On a Matrox 4Sight EV6 platform, this value is only available if MIL 10 update 86 (or later) is installed.

a
Click to summarize M_EDGE_FALLING

Specifies that an interrupt will be generated upon a high-to-low signal transition.

a g h t
U28
w
U53
z
Click to summarize M_EDGE_RISING

Specifies that an interrupt will be generated upon a low-to-high signal transition.

a g h t
U28
w
U53
z
Click to summarize M_IO_INTERRUPT_STATE +

Sets whether to generate an interrupt upon the specified transition of the I/O signal. Use M_IO_INTERRUPT_ACTIVATION to specify the transition. Note that this only applies to input signals, or I/O signals set to input (using M_IO_MODE). INQ


You must specify a combination value from the following table:
(summarize)
a g h t
U28
w
U53
z
MIL system specific

This control type is only available with auxiliary I/O signals 3-6.

t
U28
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight.

a
Click to summarize M_DEFAULT

Same as M_DISABLE.

a g h t
U28
w
U53
z
Click to summarize M_DISABLE

Specifies not to generate an interrupt.

a g h t
U28
w
U53
z
Click to summarize M_ENABLE

Specifies to generate an interrupt.

a g h t
U28
w
U53
z
Click to summarize M_IO_INVERTER +

Sets whether the specified I/O signal should be inverted. This causes the low portion of the signal (the delay period) to be high and the high portion of the signal (the active portion) to be low. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_DEFAULT

Same as M_DISABLE.

a t
U28
w
U53
z
Click to summarize M_DISABLE

Specifies not to invert the specified I/O signal.

a t
U28
w
U53
z
Click to summarize M_ENABLE

Specifies to invert the specified I/O signal.

a t
U28
w
U53
z
Click to summarize M_IO_MODE +

Sets the mode of the specified I/O signal. Note that you can only change the mode of a bidirectional (I/O) signal. INQ


You must specify a combination value from the following table:
(summarize)
g h
Click to summarize M_INPUT

Specifies that the signal is for input.

g h
Click to summarize M_OUTPUT

Specifies that the signal is for output.

g h
Click to summarize M_IO_SOURCE +

Sets the type of signal to route to an output signal, or a bidirectional signal set to output mode. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight.

a
Click to summarize M_DEFAULT

Same as M_USER_BITn.

a t
U28
w
U53
z
Click to summarize M_EXPOSURE

Specifies to route the exposure signal of the camera.

t
U28
Click to summarize M_GRAB_TRIGGER_READY

Specifies to route the internal grab trigger ready signal.

t
U28
Click to summarize M_IO_COMMAND_LISTn +

Specifies to route a bit of the I/O command register of I/O command list n, where n is the number of the I/O command list.


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

For the Matrox 4Sight GPm, n can be either 1 or 2.

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a

For Matrox Iris GTR, n must be 1.

t
U28
Click to summarize M_ROTARY_ENCODERn

Specifies to route the output of rotary encoder n, where n is the number of rotary encoders available.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

For the Matrox 4Sight GPm, n can be either 1 or 2.

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a

For Matrox Iris GTR, n must be 1.

t
U28
Click to summarize M_TIMER_STROBE

Specifies to route the internal timer strobe signal.

t
U28
Click to summarize M_TIMERn

Specifies to route the output of timer n, where n is the number of timers available.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

For the Matrox 4Sight GPm, n can be a value from 1 to 16.

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a

For Matrox Iris GTR, n can be a value from 1 to 8.

t
U28
Click to summarize M_USER_BITn

Specifies to route the state of bit n of the main static-user-output register, where n is the bit number.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a

For Matrox Iris GTR, n can be a value from 0 to 2.

t
U28
Combination value for the values listed in For routing I/O signals and setting their mode.

You must add the following value to the above-mentioned values to set the type and number of the I/O signal to affect.

function map For specifying the type and number of the I/O signal to affect
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_AUX_IOn

Specifies to affect auxiliary signal n, where n is the signal number.

For a list of the available auxiliary I/O signals, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or Matrox 4Sight.

(summarize)
a g h t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a

The following control types and control values allow you to set the bits in a static-user-output register. You can route the bits to output signals or I/O signals set to output; to do so use M_IO_SOURCE with M_USER_BIT...). To establish which user-bits can be routed to a specific signal, see the connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board.

[Matrox 4Sight GP/GPm]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight.

Note that for other Matrox imaging boards that have user-bits, but are not supported with the constants below, see MdigControl().

function map For setting the state of specified user-bits in a static-user-output register
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_USER_BIT_STATE +

Sets the state of the specified bit of a static-user-output register. INQ


You must specify a combination value from the following table:
(summarize)
a g h t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight.

a
Click to summarize M_OFF

Specifies that the specified bit is set to off.

a g h t
U28
w
U53
z
Click to summarize M_ON

Specifies that the specified bit is set to on.

a g h t
U28
w
U53
z
Click to summarize M_USER_BIT_STATE_ALL

Sets the state of all the bits in the main static-user-output register. INQ

(summarize)
a g h t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm and Matrox 4Sight-X platforms]

This constant is only available on a Host system if the Host system has been allocated on a Matrox 4Sight.

a
Click to summarize Value

Specifies a bit-encoded value that establishes the value of all the bits of the specified static-user-output register. It is recommended to specify the value in hexadecimal notation (0x), so that it is more legible to what you are setting each bit of the register.

(summarize)
a g h t
U28
w
U53
z
Combination value for M_USER_BIT_STATE.

You must add the following value to the above-mentioned value to specify the bit in a static-user-output register to affect.

function map For specifying the bit in a static-user-output register to affect
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_USER_BITn

Specifies to affect bit n of the main static-user-output register.

a g h t
U28
w
U53
z

The following control types and control values specify the settings for controlling timers and the signals generated from a timer (timer output signals). For more information, see the Timers and coordinating events section of Chapter 41: I/O signals and communicating with external devices.

function map For controlling the settings of a timer
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_TIMER_ARM +

Sets whether to enable the timer arming mechanism. If timer arming is enabled, then the timer will ignore its trigger signal (M_TIMER_TRIGGER_SOURCE) until a signal transition specified using M_TIMER_ARM_ACTIVATION occurs on the signal specified using M_TIMER_ARM_SOURCE. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_DEFAULT

Same as M_DISABLE.

a t
U28
w
U53
z
Click to summarize M_DISABLE

Specifies that timer arming is disabled.

a t
U28
w
U53
z
Click to summarize M_ENABLE

Specifies that timer arming is enabled.

a t
U28
w
U53
z
Click to summarize M_TIMER_ARM_ACTIVATION +

Sets the signal transition upon which to arm the timer, if timer arming is enabled. Use M_TIMER_ARM to enable timer arming. Use M_TIMER_ARM_SOURCE to set which input signal will arm the timer. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_DEFAULT

Same as M_EDGE_RISING.

a t
U28
w
U53
z
Click to summarize M_ANY_EDGE

Specifies that the timer will be armed by both a high-to-low and a low-to-high signal transition.

a t
U28
w
U53
z
Click to summarize M_EDGE_FALLING

Specifies that the timer will be armed upon a high-to-low signal transition.

a t
U28
w
U53
z
Click to summarize M_EDGE_RISING

Specifies that the timer will be armed upon a low-to-high signal transition.

a t
U28
w
U53
z
Click to summarize M_LEVEL_HIGH

Specifies that a timer is continuously armed during a high signal polarity.

a t
U28
w
U53
z
Click to summarize M_LEVEL_LOW

Specifies that a timer is continuously armed during a low signal polarity.

a t
U28
w
U53
z
Click to summarize M_TIMER_ARM_SOFTWARE +

Issues a software trigger to arm the timer.

To use this setting, the timer's arm source must be set to software (M_TIMER_ARM_SOURCE set to M_SOFTWARE).


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_ACTIVATE

Specifies the default behavior.

a t
U28
w
U53
z
Click to summarize M_TIMER_ARM_SOURCE +

Sets which input signal will arm the timer, if timer arming is enabled. Use M_TIMER_ARM to enable timer arming. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the source signal used to arm the specified timer, where n is the number of the auxiliary signal.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

For Matrox 4Sight GPm, n can be a value from 8 to 15.

a

With Matrox Iris GTR, n can be a value from 3 to 6.

t
U28
Click to summarize M_EXPOSURE

Specifies to use the exposure signal as the trigger source.

t
U28
Click to summarize M_GRAB_TRIGGER_READY

Specifies to route the internal grab trigger ready signal to the specified signal.

t
U28
Click to summarize M_SOFTWARE

Specifies to use software to arm the specified timer.

a t
U28
w
U53
z
Click to summarize M_TIMER_STROBE

Specifies to route the strobe's timer signal to the specified signal.

t
U28
Click to summarize M_TIMERn

Specifies to use the output signal of the specified timer as the source signal to arm the timer, where n is the timer number.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

For Matrox 4Sight GPm, n can be a value from 1 to 16.

a

With Matrox Iris GTR, n can be a value from 1 to 8.

t
U28
Click to summarize M_TIMER_CLOCK_ACTIVATION +

Sets the edge of the signal that will increment the clock used to control the active portion of the timer's output signal. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_DEFAULT

Same as M_EDGE_RISING.

a t
U28
w
U53
z
Click to summarize M_ANY_EDGE

Specifies that the clock will be incremented by both a high-to-low and a low-to-high signal transition.

a t
U28
w
U53
z
Click to summarize M_EDGE_FALLING

Specifies that the clock will be incremented by a high-to-low signal transition.

a t
U28
w
U53
z
Click to summarize M_EDGE_RISING

Specifies that the clock will be incremented by a low-to-high signal transition.

a t
U28
w
U53
z
Click to summarize M_TIMER_CLOCK_FREQUENCY +

Sets the frequency of the clock source signal for the active portion of the timer's output signal (M_TIMER_CLOCK_SOURCE).

Note that if M_TIMER_CLOCK_SOURCE is set to M_AUX_IOn or M_ROTARY_ENCODERn, and no clock source frequency is specified, the values that are normally specified or returned in units of time will be in number of ticks (clock signal transitions on the clock source).

If M_TIMER_CLOCK_SOURCE is set to M_SYSCLK, changing the frequency to any value different than the system clock's frequency will cause an error. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_UNKNOWN

Specifies that the signal is not periodic or the frequency is unknown.

a t
U28
w
U53
z
Click to summarize 0 < Value <= Frequency of M_SYSCLK

Specifies the frequency, in Hz.

a t
U28
w
U53
z
Click to summarize M_TIMER_CLOCK_SOURCE +

Sets the source of the clock that drives the active portion of the specified timer's output signal.

The clock source used for the delay can be different from the clock source used for the active portion of the timer's output signal. This is useful, for example, if you want to specify the delay in signal transitions and the active portion in nsec. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_DEFAULT

Same as M_SYSCLK.

a t
U28
w
U53
z
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the clock source, where n is the number of the auxiliary signal. If the signal is periodic, specify its frequency using M_TIMER_CLOCK_FREQUENCY.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

For Matrox 4Sight GPm, n can be a value of 8 to 15.

a w
U53
z

With Matrox Iris GTR, n can be a value from 3 to 6.

t
U28
Click to summarize M_ROTARY_ENCODERn

Specifies to use rotary decoder n as the clock source, where n is the number of the rotary decoder. If the signal is periodic, specify its frequency using M_TIMER_CLOCK_FREQUENCY.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

For Matrox 4Sight GPm, n can be 1 or 2.

a

With Matrox Iris GTR, n must be 1.

t
U28
Click to summarize M_SYSCLK

Specifies to use the allocated system's clock source.

a t
U28
w
U53
z
Click to summarize M_TIMER_DELAY +

Sets the delay between the timer trigger and the active portion of the timer's output signal.

Note, an error is generated if the specified delay cannot be respected.

The clock source used for the delay can be different from the clock source used for the active portion of the timer's output signal. This is useful, for example, if you want to specify the delay in signal transitions and the active portion in nsec. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize 0 <= Value <= Max. value

Specifies the delay. If M_TIMER_DELAY_CLOCK_SOURCE is set to M_SYSCLK or a frequency is specified using M_TIMER_DELAY_CLOCK_FREQUENCY, this value is specified in nsec. Otherwise, it is specified in number of clock ticks (signal transitions on the clock source).

Use MsysInquire() to determine the maximum possible value.

(summarize)
a t
U28
w
U53
z
Click to summarize M_TIMER_DELAY_CLOCK_ACTIVATION +

Sets the signal transition that will increment the clock used to control the delay between the timer's trigger and the active portion of the timer's output signal.

If M_TIMER_DELAY_CLOCK_SOURCE is set to M_FOLLOW_TIMER_CLOCK, changing this setting to a value different than the value of M_TIMER_CLOCK_ACTIVATION will cause an error. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_DEFAULT

Same as M_EDGE_RISING.

a t
U28
w
U53
z
Click to summarize M_ANY_EDGE

Specifies that the clock will be incremented by both a high-to-low and a low-to-high signal transition.

a t
U28
w
U53
z
Click to summarize M_EDGE_FALLING

Specifies that the clock will be incremented by a high-to-low signal transition.

a t
U28
w
U53
z
Click to summarize M_EDGE_RISING

Specifies that the clock will be incremented by a low-to-high signal transition.

a t
U28
w
U53
z
Click to summarize M_TIMER_DELAY_CLOCK_FREQUENCY +

Sets the frequency of the clock source signal for the delay between the timer's trigger and the active portion of the timer's output signal (M_TIMER_DELAY_CLOCK_SOURCE).

Note that if M_TIMER_DELAY_CLOCK_SOURCE is set to M_AUX_IOn or M_ROTARY_ENCODERn, and no clock source frequency is specified, the values that are normally specified or returned in units of time will be in number of ticks.

If M_TIMER_DELAY_CLOCK_SOURCE is set to M_SYSCLK, changing the frequency to any value different than system clock's frequency will cause an error. If M_TIMER_DELAY_CLOCK_SOURCE is set to M_FOLLOW_TIMER_CLOCK, changing the frequency to a value different than the value of M_TIMER_CLOCK_FREQUENCY will cause an error. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_UNKNOWN

Specifies that the signal is not periodic or the frequency is unknown.

a t
U28
w
U53
z
Click to summarize 0 < Value <= Frequency of M_SYSCLK

Specifies the frequency, in Hz.

a t
U28
w
U53
z
Click to summarize M_TIMER_DELAY_CLOCK_SOURCE +

Sets the source of the clock that drives the delay between the timer's trigger and the active portion of the specified timer's output signal.

The clock source used for the delay can be different from the clock source used for the active portion of the timer's output signal. This is useful, for example, if you want to specify the delay in signal transitions and the active portion in nsec. INQ


You must specify a combination value from the following table:
(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 26 (or later) is installed.

a
Click to summarize M_DEFAULT

Same as M_FOLLOW_TIMER_CLOCK.

a t
U28
w
U53
z
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the clock source, where n is the number of the auxiliary signal.

(summarize)
a t
U28
w
U53
z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

For Matrox 4Sight GPm, n can be a value from 8 to 15.

a w
U53
z

With Matrox Iris GTR, n can be a value from 3 to 6.

t
U28
Click to summarize M_FOLLOW_TIMER_CLOCK

Specifies to use the clock source specified by M_TIMER_CLOCK_SOURCE. If the clock source is set to this value and M_TIMER_CLOCK_SOURCE is changed, this clock source changes as well. Additionally, any changes to M_TIMER_CLOCK_ACTIVATION and M_TIMER_CLOCK_FREQUENCY will also be reflected in M_TIMER_DELAY_CLOCK_ACTIVATION and M_TIMER_DELAY_CLOCK_FREQUENCY.

(summarize)
a t
U28
w
U53
z
Click to summarize M_ROTARY_ENCODERn

Specifies to use rotary decoder n as the clock source, where n is the number of the rotary decoder.

(summarize)
a t
U28
w
U53
z
MIL system specific