Device Communication Information

Device Communication Information

Tables

I/O Device Editor

Item

Description

New Device

Adds a device.

New Station

Adds a station to a serial device.

Delete Device

Deletes the selected device or station.

Copy Device

Saves the selected device’s content in the clipboard. This includes stations for serial devices.

Expand All

Shows all dropdown content within the I/O Device Editor window.

Collapse All

Hides all dropdown content within the I/O Device Editor window.

Collapse

Collapses the selected tree from Ethernet Device or Serial Device.

Expand

Expands the selected tree from Ethernet Device or Serial Device.

Ethernet Device

Lists all created ethernet devices under a dropdown.

Serial Device

Lists all created serial devices and their stations under a dropdown.

Certificates Editor

Opens the Certificates Editor to manage Key Pairs and Trust Stores.

OK

Closes the I/O Device Editor window.

Β 

Add New I/O Device

Item

Description

Connection Type

Select between Ethernet or Serial to determine the type of link between the HMI project and an external device.

Device Name

Assigns a name to the user’s device.

Device Type

Assigns a protocol to communicate over for the I/O device.

Β 

I/O Device Editor - Ethernet Device

Item

Description

Device Name

Assigns a name to the user’s device.

Device Protocol

Assigns a protocol to communicate over for the I/O device. The current protocols Canvas supports are CIMON PLC (HMI Protocol), Allen-Bradley EtherNet/IP, Fatek FBS, LSIS FEnet, Mitsubishi MELSEC Ethernet, Modbus TCP, ODVA EtherNet/IP, OPC UA Client, Omron FINS, Proface GPEthernet and Siemens S7.

Timeout (ms)

Sets the maximum time to wait without any response before listing a communication failure.

Retry Count

Number of retries to reconnect for when a communication failure occurs.

Swap (Integer)

Swaps the upper and lower bytes of integer data.

Swap (String)

Swaps the upper and lower bytes of a string word data.

Swap (Float32)

Swaps the upper and lower bytes of float32 data.

Swap (Float64)

Swaps the upper and lower bytes of float64 data.

Station Number

The specific address of identifier of the PLC to communicate within a network.

String Encoding

Assign an encoding method for reading and writing strings stored on a device. This setting can be overwritten for tags in the Edit Tag menu. The current methods supported by Canvas are ASCII, ISO-8859-1, Latin1, Windows-1252, Windows-949, CP949, Shift_JIS, GBK, and UTF-8.

String Encoding Method

When an invalid character is encountered, the gateway will do one of the following:

Replace

Will replace any invalid characters within the string with β€œ?”.

Skip

Will skip the invalid character and continue with the next one.

Stop

Will stop reading the string and truncate any remaining characters.

Read Immediately After Write

If toggled, it will perform a write request and immediately perform a read without needing to wait for a scan.

PLC Type

Select the type of PLC that will be connected. Is only available in specific protocols.

Message Type

Assigns a specific type of transmission type between devices.

Explicit

Message is for point to point communication between devices.

Implicit

Used for real-time I/O data exchange, it does not require explicit designation of the target device.

UCMM

Unconnected Message Manager allows unconnected and unscheduled messages to be exchanged between devices that do not have an established connection or a fixed exchange schedule.

Use Multiple Service

Toggling this will allow the capability of the devices to handle multuple concurrent service reuqests or operations from different devices.

Host

The IPv4 address of the target I/O Device.

Ethernet Type

Assign the Ethernet protocol to use to connect to the device.

Port

Choose the port number for the target I/O device.

Slot Number

The slot number of the device. Valid numbers are from 0 - 255.

Frame Type

Assigns a frame type. Canvas only supports 4E currently.

Unit Identifier

Assigns a unit ID of the device. Valid numbers are from 0 - 255.

Application URI

Assigns the Uniform Resource Identifier to locate the asset on the network.

Enable Encryption

Checking this will enable encryption and allow some more features to be changed.

Genereate Encryption Certificates

Will automatically generate a key pair on the device. Unchecking this box will allow the user to assign a specific key pair instead.

Encryption Key Pair

Selects a key pair to use for encryption. Users may create a new one or use an existing one. Key pairs may be created and edited within the Certificates Editor.

Security Policy

Select an encryption method for communication with the server. Current encryptions methods are β€œBasic128Rsa15”, β€œBasic256”, β€œBasic256Sha256”, β€œAes128_Sha256_RsaOaep” or β€œNone”.

Message Security

Selects if the data should be signed, encrypted, signed and encrypted, or neither.

Server Name

Assign a name to the server.

Authentication Method

Select the Authentication Method for the encryption. Options include β€œAnonymous” or β€œUsername”

Authentication Username

Enters the username for the client.

Authentication Password

Enter the password for the specified client.

Source Node ID

Assign a Source Node ID. Valid numbers are 0-254 for TCP and 1-254 for UDP.

Source Network ID

Assign a Source Network ID. Valid numbers are 0-65535.

Destination Network ID

Assign a Destination Network ID. Valid numbers include 0-65535.

Destination Node ID

Assign a Destination Node ID. Valid numbers include 0-65535.

Destination Unit ID

Assign a Destination Unit. Valid numbers include 0-65535.

Rack Number

Assign a Rack Number of the target device. Valid numbers include 0-255.

I/O Device Editor - Serial Device

Item

Description

Device Name

Assigns a name to the user’s I/O serial device.

Device Protocol

Assigns a protocol to use to communicate with the serial device. The options are CIMON PLC (HMI Protocol), LSIS Cnet, Mitsubishi MELSEC Serial, Modbus RTU, Omron HostLink, Panasonic FP7, and Yokogawa FA-M3.

Timeout (ms)

Sets the maximum time to wait without any response before listing a communication failure.

Retry Count

Number of retries to reconnect for when a communication failure occurs.

String Encoding

Specifies the encoding method for reading and writing string values stored on the device. The available encoding methods are ASCII, ISO-8859-1, Latin1, Windows-1252, Windows-949, CP949, Shift_JIS, GBK, and UTF-8.

String Encoding Method

When an invalid character is encountered, the gateway will do one of the following:

Replace

Will replace any invalid characters within the string with β€œ?”.

Skip

Will skip the invalid character and continue with the next one.

Stop

Will stop reading the string and truncate any remaining characters.

Read Immediately After Write

If toggled, it will perform a write request and immediately perform a read without needing to wait for a scan.

PLC Type

Select the type of PLC that will be connected. Is only available in specific protocols.

Serial Port

Assigns a COM port for the device. COM1 is for RS-422/485, COM2 is for RS-232-C, and COM3 is for RS-232-C for 10, 12, and 15 inch Xpanels only.

Comm Type

Assigns a communication type for the COM port. COM2 and COM3 are forced to be RS-232, but COM1 can be RS-422 or RS-485.

Baudrate

Controls the rate at which information is transferred between devices. The options are 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, and 230400.

Parity

Used to determine if the device correctly received the character. Both devices need to have the same parity.

Data Bits

Assigns the number of data bits there are in each packet between 7 and 8.

If the data contains any Korean characters, select 8 bits to avoid errors.

Stop Bits

Assigns the number of stop bits there are between each frame between 1 and 2.

Flow Control

Limits how much data is being sent into the device. This can be either On, Off, or Control.

Transmission Delay

Sets the time in miliseconds that the client device will wait before sending a request.

Read Block Tolerance

Sets the allowed amount of unused device addresses per block. Only applies to Modbus RTU.

Frame Type

Used to confirm that data sent was correctly transmitted / received. Only applies to Mitsubishi MELSEC Serial, and only 3C is supported in Canvas.

Β 

Certificates Editor

Item

Description

Add new Key Pair / Add new Trust Store

Adds a key pair or trust store.

Delete Key Pair / Delete Trust Store

Deletes the selected key pair or trust store.

Edit Key Pair / Edit Trust Store

Edits the selected key pair or trust store.

OK

Closes the Certificates Editor window.

Β 

Key Pairs

Item

Description

Name

Displays all of the current key pair names in order of creation.

Certificate

Displays all of the current certificates for created key pairs.

Private Key

Displays all of the current private keys for created key pairs.

Description

Displays all of the current descriptions of created key pairs.

Β 

New Key Pair

Item

Description

Name

Assigns a name to the user’s key pair.

Certificate

Assigns the selected file to be the certificate of the key pair.

Private Key

Assigns the selected file to be the private key of the key pair.

Description

Assigns a description to the key pair.

Use Password

Controls whether or not the key pair will have a Private Key Password or not.

Private Key Password

Assigns a private key password to the key pair.

Β 

Trust Stores

Item

Description

Trust Store

Displays all of the current trust store names in order of creation.

Description

Displays all of the current descriptions of created trust stores.

Certificates

Displays all of the currently added certificates in created trust stores.

Β 

New Trust Store

Item

Description

Name

Assigns a name to the user’s trust store.

Certificates

Assigns the selected files using the Add Certificate icon to be certificates in the trust store.

Description

Assigns a description to the trust store.

Β 

Data Server Editor

Item

Description

New Device

Adds a device.

Delete Device

Deletes the selected device.

Copy Device

Saves the selected device’s content in the clipboard.

Paste Device

Pastes the device’s content in a Data Server Editor window. This can be done through different projects, but ethernet devices will only paste under ethernet and serial devices will only paste under serial.

Expand All

Shows all dropdown content within the Data Server Editor window.

Collapse All

Hides all dropdown content within the Data Server Editor window.

Collapse

Collapses the selected tree from Ethernet Device or Serial Device.

Expand

Expands the selected tree from Ethernet Device or Serial Device.

Device Setting

Opens the Device Settings tab.

Device Tag

Opens the Device Tag tab.

Certificates Editor

Opens the Certificates Editor to manage Key Pairs and Trust Stores.

Payload Editor

Opens the Payload Editor to manage Payload settings and properties.

OK

Closes the Data Server Editor window.

Β 

Add New Server Device

Item

Description

Connection Type

Select between Ethernet or Serial to determine the type of link between the HMI project and an external device.

Device Name

Assigns a name to the user’s device.

Device Type

Assigns a protocol to communicate over for the data server device.

Β 

Device Setting - Ethernet Device

Item

Description

Device Name

Assigns a name to the user’s device.

Device Protocol

Assigns a protocol to use to communicate with the serial device. The options are MQTT JSON Publisher, Modbus TCP and OPC UA Server.

Use All Tags

Toggle that allows the users to host all tags in the project on the data server.

Server Name

Assign a name to the server.

Application URI

Assigns the Uniform Resource Identifier to locate the asset on the network.

Application Name

Sets the name of the Application.

Port

Choose the port number for the target Data Server.

Unit ID

Assigns a value to be the slave/server ID for Modbus TCP communication.

String Encoding

Specifies the encoding method for reading and writing string values stored on the device. The available encoding methods are ASCII, ISO-8859-1, Latin1, Windows-1252, Windows-949, CP949, Shift_JIS, GBK, and UTF-8.

String Encoding Method

When an invalid character is encountered, the gateway will do one of the following:

Replace

Will replace any invalid characters within the string with β€œ?”.

Skip

Will skip the invalid character and continue with the next one.

Stop

Will stop reading the string and truncate any remaining characters.

Broker Address

IPv4 address or hostname for the MQTT broker.

Port

hoose the port number for the target MQTT broker.

Client ID

Assigns a client ID for publishing and subscribing.

Use Clean Session

Enables connecting to the MQTT broker using a non persistent connection.

Keep Alive

Notes the keepalive time used by the MQTT client. This will be displayed in seconds.

Use SSL

Enables the use of SSL encryption with the broker.

Key Pair

Select a key pair to use for SSL encryption. These key pairs can be edited in the Certificates Editor window.

Trust Store

Select a trust store to use for SSL encryption. These trust stores can be edited in the Certificates Editor window.

Use MQTT Passwords

If toggled, a username and password will be used for connecting to the MQTT

MQTT Username

Assign a username for connecting to the MQTT broker.

MQTT Password

Assign a password for connecting to the MQTT broker.

Use Message Queue

Toggle that will tell if the client should use a message queue, and will store messages when the client is disconnected.

Message Queue Size

Assigns the number of messages to be held in the message queue. Acceptable values are 20 to 10000.

Message Queue Publish Rate Limit

Minimum time between publishes, with 0 being as soon as possible. Maximum value is 10000.

Use Message Queue Age Limit

Toggle that will impose an age limit on queued messages.

Message Queue Age Limit (s)

The maximum age of a message in seconds that will be published.

Running Mode

Sets the criteria for when to publish a payload.

On Change any

Will publish a message every time a tag value updates. This is the default.

On Scan Delta

Will publish after every scan, but only generates message for changed tag values.

On Scan All

Will publish all tag values after every scan. Will publish even if there are no changes.

Polling Rate (ms)

Determins the rate for polling tag changes. This will only be available in β€œOn Scan Delta” or β€œOn Scan All”

Publish Payload Format

Can select one of the following built-in payload formats for publishing:

The client devices must be configured to listen for payloads with the matching format.

Single

Each payload contains data from a single tag.

Multi

Each payload contains data from multiple tags.

No Wrap

The payload root object is the tag object, and all tag properties are direct children of the root object. Only available for β€œSingle” payloads.

Wrap

Uses the tag ID as a property name for the value object. Available for both Single and Multi Payloads.

Array Wrap

Stores an array of tag objects named β€œTags”. The tag ID property is included in the tag object.

Basic

Includes the following properties: Value and Value Time.

Full

Includes the following properties: Value, Value Time, Type, Read Time, Device, and Quality.