4.2 Flow Editor

This section describes the Flow Editor. Flow Editor is the operation screen of SpeeDBee Synapse.

4.2.1 About the mode#

The Flow Editor has three types of modes:

4.2.2 Items on the screen#

This section describes the items shown on the screen of Flow Editor.

4.2.2.1 Edit Mode#

The items shown on the screen of Edit Mode Flow Editor are as follows.

The Edit Mode screen consists of the following: ① Header, ② Componentbase, ③ Panel, and ④ Data monitor

① Header

② Componentbase

• The componentbase is available in the following types:

③ Panel

• For detail, see Panel.
• The panel named "System" is exclusively used for system component.

③-① Component

• For detail, see Component.

④ Data monitor

• For detail, see Data Monitor.

4.2.2.2 Run Mode#

The items shown on the Run Mode Flow Editor screen are as follows:

The Run Mode screen consists of ① Header, ② Panel, ③ Panel status, ④ Data monitor, and ⑤ System resources.

① Header

② Panel

• For detail, see Panel.
• The panel named "System" is exclusively used for system component.

②-① Component

• For detail, see Component.

③ Panel Status

• For detail, see Panel Status.

④ System resources

• For detail, see System Resources.

⑤ Data monitor

• For detail, see Data Monitor.

4.2.2.3 List Mode#

The items shown on the screen of List Mode Flow Editor are as follows.

The List Mode screen consists of the following: ① Header, ② List header, and ③ Component list

① Header

② List header

③ Component list

4.2.3 Screen Operation#

This section describes how to operate the Flow Editor.

4.2.3.1 Setting menu#

This section describes how to operate the Setting Menu.

4.2.3.1.1 Language configuration#

Languages can be switched by following the steps below.

1. Press the Setting Menu icon.

   

2. Select the language selection pull-down menu.

   

3. Select a language.

   

4. A selected language is reflected in SpeeDBee Synapse.

The currently available languages are as follows:

4.2.3.1.2 Project Settings#

This enables the configuration of a project. For detail, see Management of Configuration Information (Project).

4.2.3.1.3 Server Settings#

By following the steps below, server settings can be confirmed and updated, and the database can be reset.

1. Press the Setting Menu icon.

   

2. Select "Server Settings".

   

3. From the following items, input any one and press "Save" to update the configuration.

   

   Item		Description
   Server	Server instance name	This is a name assigned to SpeeDBee Synapse. The name is displayed in the general panel of Run Mode. (If multiple SpeeDBee Synapse are used, they can be distinguished by assigning different names individually.)
   	Description	Descriptions including the purpose of SpeeDBee Synapse
   Database	Storage path	The database save location directory Note: In some environments, this setting cannot be changed/edited.
   	File type storage path	File type database save location directory Note: In some environments, this setting cannot be changed/edited.
   	DB log path	Directory for database log save location Note: In some environments, this setting cannot be changed/edited.
   	Storage keep size	Maximum size to store data in storage If the data in the storage exceeds this keep size, the data is deleted starting from the oldest data. If the keep size is undefined, it is unlimited.
   	Specify the storage keep time by group.	If ON is selected, the keep time—the period for retaining data in the storage—can be configured for each group. Data that exceeds the keep time is deleted. However, even before the keep time expires, if the storage keep size is exceeded, data is deleted starting from the oldest data.
   	Memory keep time (sec)	This is the period during which data is stored in memory.
   Core API	Port	This is the port number used by the SpeeDBee Synapse to communicate between the web interface and the internal server. Note: In some environments, this setting cannot be changed/edited.

Delete Data

1. Press "Delete data".

   

2. Select the data to delete and press "Delete".

   

   Item	Description
   Serializer tempfiles	These are temporary output files created by the serializer component. Note: If deleted, the system is restarted.
   Application Log	System logs for the core, component, and database
   Application log (UI)	WEBUI system log
   Database	Time series database of SpeeDBee Synapse Note: If deleted, the system is restarted.
   Create a backup	A backup is created before the database is deleted. Note: This can be selected only when the database is checked.

3. Press "Yes".

   

4. The selected data is deleted.

Start/Stop core

1. Press "Stop core" to stop the core function of SpeeDBee Synapse.

   

2. Press "Start core" to start the core function of SpeeDBee Synapse.

   

4.2.3.1.4 General Settings#

The general settings can be confirmed and updated by following the steps below.

1. Press the Setting Menu icon.

   

2. Select "General Settings".

   

3. Switch the tab, edit the items of choice, and then press "Save" to update the configuration.

   

   Item	Description
   Component default	This sets the common initial default value for the component.
   Log Setting	This configures the application log.
   Data directory setting	This configures the data directory.

4.2.3.1.5 Component default#

This confirms and edits initial values for common inputs of components.

4.2.3.1.6 Log configuration#

This confirms and edits the application log configuration.

4.2.3.1.7 Data directory setting#

This confirms and edits the data directory configuration.

Note: If you change the data directory, the changes will be reflected in the following components from the next startup, and the new directory will be used.

• VIDEO Collector
• File Emitter
• Event Recorder

4.2.3.1.8 Custom (Python)#

The Python Custom Component can be configured. For detail, see Creation and Python Custom Component.

4.2.3.1.9 Custom (C)#

C Custom Component can be configured. For detail, see Creation of C language Custom Component.

4.2.3.1.10 Grafana Setup#

This enables the configuration of Grafana. For detail, see Integration with Grafana.

4.2.3.1.11 Download support files#

Files to be given to the SpeeDBee Synapse support staff can be downloaded by following the steps below.

1. Press the Setting Menu icon.

   

2. Select "Download support files".

   

3. Select the file to download.
   Note: Select "Config, Log files only" only as a standard procedure. Confidential information does not have to be included unless instructed by support staff to do so.

   

4. Press "Download".

   

5. Support files are downloaded.

   Contact the support staff by following the instructions in Contact manufacturer.

4.2.3.1.12 Publish access token#

Access token can be published by following the steps below. The published access tokens can be used in "DB query service", "Integration with Grafana", and "Integration with control program".

1. Press the Setting Menu icon.

   

2. Select "Publish access token".

   

3. Input the following items and press "Publish".

   

   Item	Description
   Token name	Name to identify a token
   Expiration date	Expiration date for the token

   About the expiration date of access tokens

   If the expiration date for a token is set long, the security risk in the event of a token breach increases. Conversely, if the expiration date is set too short, security is enhanced, but the access token must be updated frequently. Depending on a predetermined operation policy, consider updating the access token regularly.

4. After copying a published access token, press "Close".

   Storage of access token

   The access token is displayed only once. The same token cannot be retrieved once this screen is closed, so be sure to make a copy.

   

5. Published access tokens are added to the list.

   

4.2.3.1.13 HTTP/HTTPS communication#

The user device and SpeeDBee Synapse HTTP communication can be configured by following the steps below.

1. Press the Setting Menu icon.

   

2. Seelct "HTTP/HTTPS communication".

   

3. Input the following items and press "Reflect and restart".

   

   Item	Description
   Bind address	This is the address at which SpeeDBee Synapse accepts requests. Note: In some environments, this setting cannot be changed/edited.
   Port	This is the port at which SpeeDBee Synapse accepts requests. Note: In some environments, this setting cannot be changed/edited.
   Encrypt communication	Select ON to use encrypted communication (HTTPS). Note: In some environments, this setting cannot be changed/edited.
   SSL/TLS certificates	This is a digital certificate used for encryption. Note: The certificate needs to be obtained from the certificate authority (CA).
   Secret key	This is a secret key linked to the SSL/TLS certificate. Note: The secret key needs to be obtained from the certificate authority (CA).

4. The whole system is restarted to reflect configurations. After restarting, SpeeDBee Synapse can be accessed with the URL that matches the settings.

   When using encrypt communicationWhen not using encrypt communication

   https://< Host name or IP address of the device>:< This is the port at which SpeeDBee Synapse accepts requests.>/
   

   http://< Host name or IP address of the device >:< This is the port at which SpeeDBee Synapse accepts requests.>/
   

4.2.3.1.14 Proxy Settings#

This section describes the operation of Proxy Settings. The proxy information set here can be referenced from the settings of each component, and its communication can be route through a proxy.

Proxy-Compatible Components

• MQTT Collector
• MQTT Emitter
• Cloud Emitter for AWS
• Cloud Emitter for Azure
• MQTT Client

By setting a default proxy, communication for specific operations will be routed through the proxy.

Operations Affected

• Adding external libraries for Python custom components

Add

Proxy settings can be added by following the steps below.

1. Press the Setting Menu icon.

   

2. Select "Proxy Settings".

   

3. Select "ADD".

   

4. Input the following items and press "SAVE".

   

   Item	Description
   Server name	An optional name to identify the server. Note: Components configured to communicate via a proxy reference the server name to load their settings. Therefore, if the server name is changed, the components must be reconfigured.
   Protocol	Type of proxy to use.(HTTP)
   Host	Host name or IP address of the proxy server.
   Port	Port number of the proxy server.
   Authentication method	Proxy server authentication method. (No Authentication, Basic Authentication)
   Username	Username for Basic Authentication.
   Password	Password for Basic Authentication.

5. The saved setting will be added to the list.

   

Edit

Proxy settings can be edited by following the steps below.

1. Press the Setting Menu icon.

   

2. Select "Proxy Settings".

   

3. Select the edit icon.

   

4. Input the following items and press "SAVE".

   

   Item	Description
   Server name	An optional name to identify the server. Note: Components configured to communicate via a proxy reference the server name to load their settings. Therefore, if the server name is changed, the components must be reconfigured.
   Protocol	Type of proxy to use.(HTTP)
   Host	Host name or IP address of the proxy server.
   Port	Port number of the proxy server.
   Authentication method	Proxy server authentication method. (No Authentication, Basic Authentication)
   Username	Username for Basic Authentication.
   Password	Password for Basic Authentication.

Default Proxy

Default proxy can be set by following the steps below.

1. Press the Setting Menu icon.

   

2. Select "Proxy Settings".

   

3. Select the proxy to set as the default.

   

   Note: Pressing a proxy that is set as the default will unset it, leaving no default proxy configured.

   

Delete

Proxy settings can be deleted by following the steps below.

1. Press the Setting Menu icon.

   

2. Select "Proxy Settings".

   

3. Press the delete icon.

   

   Note: If a deleted proxy setting was being referenced by a component, the component will need to be reconfigured.

4.2.3.1.15 Download execution license configuration#

Configuration can be downloaded for the execution license environment. For details, see Execution license.

4.2.3.1.16 Software Information#

Software information and license information can be confirmed, and a license can be registered by following the steps below.

1. Press the Setting Menu icon.

   

2. Select "Software Information".

   

3. The following items are displayed:

   

   Item		Description
   Software Information	Version	The version of SpeeDBee Synapse
   	Build No.	The build No. of SpeeDBee Synapse
   System Information	Platform	Platform of the system
   	MAC address	MAC address of the system
   License	Expiration	The expiration date of the registered license
   	Platform	The platform that the registered license supports
   	MAC address restriction	MAC addresses that the registered license supports
   	Point	Points granted for registered licenses
   	License type	The registered license type

License registration

1. Input the license key to the license key input section.

   

2. Press "Save".

   

3. The license is registered. The information of the registered license is displayed on the screen.

   

4.2.3.1.17 About Points#

Points to use various functions are given to each SpeeDBee Synapse license. When SpeeDBee Synapse functions are used, the corresponding number of points is consumed.

If the points are 0, no points are consumed.
If the point is 2, two points are consumed if the configuration is saved and operated.
Also, when the same function is used simultaneously, the number of points consumed remains two points.
For example, even when two MQTT Emitters are used, the number of points consumed remains two.

If there is a shortage of points for functions to run simultaneously, the component operation is disabled.

4.2.3.2 User Management#

This section describes user management operations.

4.2.3.2.1 Add#

Users can be added by following the steps below.

1. Press the User Management icon.

   

2. Select "User Management".

   

3. Press "Add".

   

4. Input the following items and press "Save".

   

   Item	Description
   Disable	Checking this disables a user, preventing them from logging in.
   Login ID	ID to enter when logging in
   Username	Name assigned to a user (optional)
   User Role	System administrator: Can perform all operations. This role is granted to the initial user "admin", and at least one administrator is required. Manager: Can perform all operations. System administrators cannot be added, updated, or deleted. Operator: Can view Run Mode and start and stop components. Viewer: Can view Run Mode.
   Password	Password to enter when logging in
   E-mail address	E-mail address to be linked to the user (Optional)
   Viewable panel	Panels that can be viewed by users (This is set only when the user role is Operator or viewer.)

5. The user is added.

4.2.3.2.2 Edit#

The user information can be edited by following the steps below.

1. Press the User Management icon.

   

2. Select "User Management".

   

3. Press the edit icon of the user to edit.

   

4. Edit the following items and press "Save".

   

   Item	Description
   Disable	Checking this disables a user, preventing them from logging in.
   Login ID	ID to enter when logging in
   Username	Name assigned to a user (optional)
   User Role	System administrator: Can perform all operations. This role is granted to the initial user "admin", and at least one administrator is required. Manager: Can perform all operations. System administrators cannot be added, updated, or deleted. Operator: Can view Run Mode and start and stop components. Viewer: Can view Run Mode.
   Password	Password to enter when logging in
   E-mail address	E-mail address to be linked to the user (Optional)
   Viewable panel	Panels that can be viewed by users (This is set only when the user role is Operator or viewer.)

5. The edited content is saved.

4.2.3.2.3 Delete#

Users can be deleted by following the steps below.

1. Press the User Management icon.

   

2. Select "User Management".

   

3. Press the edit icon of the user to delete.

   

4. Press "Delete".

   

5. The user is deleted.

4.2.3.2.4 Profile#

The information of a user that is currently logged in can be checked by following the step below.

1. Press the User Management icon.

   

2. Select "Profile".

   

3. The following items are displayed for the user who is currently logged in.

   

   Item	Description
   Login ID	ID to enter when logging in
   Username	Name assigned to a user (optional)
   Password	Password to enter when logging in
   E-mail address	E-mail address to be linked to the user (Optional)

4. After editing the items and clicking "Save", the edited version is saved.

   

4.2.3.2.5 Login#

Users can log in to SpeeDBee Synapse by following the steps below.

1. Go to "http://{ IP address of the environment where SpeeDBee Synapse is running }:8120".

2. Input the user's "login ID" and "password" and press "login".

   

3. Log the user in to SpeeDBee Synapse.

4.2.3.2.6 Logout#

Users can log out of SpeeDBee Synapse by following the steps below.

1. Press the User Management icon.

   

2. Select "Logout".

   

3. This logs the user out of SpeeDBee Synapse.

4.2.3.3 Panel#

This section describes panel operations.

4.2.3.3.1 Add#

Panels can be added by following the steps below.

1. Press the + icon on the tab menu of the panel.

   

2. The panel is added.

   

4.2.3.3.2 Changing a name#

Panel names can be changed by following the steps below.

1. Right-click a panel tab.

   

2. Select "Panel Settings".

   

3. Input the panel name and press "Save".

   

4. The panel name changes to the entered input.

   

4.2.3.3.3 Rearranging#

Panels can be rearranged by following either of the steps below.

• Rearranging from the panel tab context menu

  1. Right-click a panel tab.

     

  2. Select "Move Right" or "Move Left".

     

  3. The panels are rearranged.

     

• Rearranging by dragging and dropping the panel tab

  1. Drag a panel tab.

     

  2. Drop it at the place where you want to move the panel.

     

  3. The panels are rearranged.

     

4.2.3.3.4 Delete#

Panels can be deleted by following the steps below.

1. Right-click a panel tab.

   

2. Select "Delete".

   

3. The panel is deleted.

   

4.2.3.3.5 Replicate#

Panels of the same configurations can be replicated by following the steps below.

1. Right-click a panel tab.

   

2. Select "Replicate".

   

3. A panel with the same configurations of the original is replicated.

   

4.2.3.3.6 Display#

Panels can be displayed by following the steps below.

1. Click the tab of the panel to display.

   

2. The panel whose tab is clicked is displayed.

4.2.3.3.7 Component Search#

The location of components registered in the panel can be searched by following the steps below.

1. Input the component name in the search box at the top right of the panel.

   

2. Select from the suggestions.

   

3. The selected component is displayed in the center of the panel.

   

4.2.3.3.8 Adjusting the display magnification#

The display magnification of the panel can be adjusted by following the steps below.

1. The current magnification of the panel is displayed at the bottom right of the panel.

   

2. Move the slider in the + direction to enlarge the display to fullscreen, and move it in the – direction to reduce the display.

   

3. Pressing + enlarges the display magnification by 5%, and pressing - reduces the display magnification by 5%.

   

4. Pressing the Overall Display button shows the entire component arranged on the panel on the screen.

   

4.2.3.3.9 Overall Panel#

The entire panel can be displayed by following the steps below. The entire panel shows the information of individual panels.

1. Select "General" in the panel tab.

   

2. This displays the server instance name, panel list, and operation status of individual panel component.

   

3. Press "DETAIL" to go to each panel.

   

4.2.3.3.10 Panel Status#

For each panel, the following information is displayed.

The following information is displayed for operating components on the panel.

4.2.3.4 Component#

This section describes component operations.

4.2.3.4.1 Add#

Components can be added by following the steps below.

1. Select a component from the left menu and drag the icon.

   

2. Drop it on top of the panel.

   

3. For some components, the dialog is displayed to select a component to connect to the IN Port. Select the component to connect and press "Select".

   

4. A configuration dialog opens. Input configuration items there and press "Save".

   

5. The component is added to the panel.

   

4.2.3.4.2 Edit#

Component configurations can be edited by following the steps below.

1. Press the Configuration icon of the component.

   

2. A configuration dialog opens. Edit configuration items there and press "Save".

   

3. The edited version is saved.

4.2.3.4.3 Delete#

Components can be deleted by following the steps below.

• This is how to delete a component from the configuration icon of the component.

  1. Press the Configuration icon of the component.

     

  2. The configuration dialog opens. Press "Delete".

     

  3. The component is deleted.

• This is how to delete a component using its context menu of the component.

  1. Right-click on the component and select "Delete".

     

  2. The component is deleted.

4.2.3.4.4 Copy & Paste#

Components of the same configurations can be replicated by following the steps below.

1. Copy the component using one of the following ways.

   • Right-click on the component and select "Copy".

     

   • While clicking to select the component, press the "C" key while holding down the "Ctrl" key on the keyboard.

     

2. Paste the component in one of the following ways.

   • Right-click the panel and select "Paste".

     

   • Press the "V" key while holding down the "Ctrl" key on the keyboard.

3. A component with the same configurations as the copied one is created.

   

4.2.3.4.5 Multiple Select#

Multiple components can be selected by clicking each component while holding down the "Ctrl" key on the keyboard.

After selecting multiple components, components selected from the context menu or through keyboard operation can be Copied & Pasted or Deleted.

To deselect multiple components, click anywhere in the panel except the component.

4.2.3.4.6 Confirming configurations#

Component configurations can be confirmed by following the steps below.

1. Press the Configuration icon of the component.

   

2. A dialog opens and displays component configuration items and configuration values.

   

4.2.3.4.7 Component satatus#

Component operation status can be checked by following the steps below.

• Status

  The status light displays the operational status of the component. For detail about the status, see Status List.

  

• Data volume

  This displays the volume of data for the following components.

  • Input and output data per minute
  • Emission and reception data per minute

  Click this to switch between displaying the number of data and the number of bytes.

  

4.2.3.4.8 Start/Stop#

Components can be started/stopped by following the steps below.

(All components)

1. Press the "Start" button on the header.

   

2. This starts all data collection flows registered in SpeeDBee Synapse.

   

3. Press the "Stop" button on the header.

   

4. This stops all data collection flows registered in SpeeDBee Synapse.

   

(Panel Unit)

1. Press the "Start" button on the panel.

   

2. This starts the operation of the data collection flow registered in the panel.

   

3. Press the "Stop" button on the panel.

   

4. This stops the operation of data collection flow registered in the panel.

   

(Component Unit)

1. Press the Start icon of the component.

   

2. This starts the component and begins processing.

   

3. Press the Stop icon of the component.

   

4. This stops the component and ends processing.

   

4.2.3.4.9 Display manual for component to operate#

When the component to operate is on the display, the manual for the target screen can be shown.

1. Press the Manual icon when the component is displayed.
2. The manual for the component to operate opens in a separate window.

4.2.3.5 Flowlink#

This section describes flowlink operations.

4.2.3.5.1 Add#

Flowlink can be added by following the steps below.

1. Drag the OUT Port or SYSTEM Port of the component.

   

2. Release the mouse button on the IN Port of another component.

   

3. This adds a flowlink between these components.

   

4.2.3.5.2 Filter#

Left-clicking the flow link icon or right-clicking the flow link allows filter configuration.

Configuration can restrict the data flowing through the flow link. For more details, see “Filter”.

4.2.3.5.3 Delete#

Flowlink can be deleted by following the steps below.

1. Right-click the flow link or left-click the icon.

   

2. Select "Flowlink Delete".

   

3. The flowlink is deleted.

4.2.3.6 Data monitor#

By clicking the port of the component, the data that is flowing to the port can be checked on the data monitor.

4.2.3.6.1 Change configurations#

Change types

The data monitor types can be changed by following the steps below.

1. Click on the data monitor display type selection form.

   

2. Select a type.

   

3. The data monitor of the selected type is displayed.

Configure thinning interval

The data monitor displays data by thinning them at specified intervals.
When the thinning interval is input in "Thinning interval(ms)", it is reflected in the data monitor.

Configure delay time

The data monitor displays the latest value as the current time minus the "delay time(ms)".
When the value is input in "Delay time(ms)", it is reflected in the data monitor.

4.2.3.6.2 Distribution#

The graph displays the data flowing through the port over a one-minute period. The graph displays the following information.

When the cursor is placed on the point, the data content and the time at which the data flowed are displayed.

4.2.3.6.3 Latest value#

The following information is displayed for all data items on the port.

• Latest value
• Time at which the latest value flowed

When data values are changed, they are displayed in red.

Pressing the Clear button restores the data items that have turned red to their original colors.

4.2.3.6.4 Table#

The data that flowed into the port are displayed in table format. The table displays the following information. The number of table rows displayed per page is automatically adjusted according to the height of the data monitor.

If the table contains more rows than can fit on one page, pages can be switched.

If there are more than eight data items on a port, selecting a column heading in the table changes the data items displayed in that column. When blank is selected, the corresponding section is not displayed.

4.2.3.6.5 File#

If the data is in a file format, the following file information is displayed.

• File size ... Size of the file.
• Media type ... Media type of the file.
• Timestamp ... Time range of the data contained in the file
• File content

4.2.3.7 System resources#

This section describes system resources.

4.2.3.7.1 CPU#

When the cursor is placed on the gauge, the following information is displayed.

The dark portion of the gauge represents the current CPU usage and the light portion represents the maximum CPU usage that has been reached during operation.

The gauge changes color according to the percentage of CPU usage, as shown in the table below.

Pressing the Refresh icon resets the Max Usage.

4.2.3.7.2 MEMORY#

When the cursor is placed on the gauge, the following information is displayed.

The colored portion of the gauge represents memory usage.

The gauge changes color according to the percentage of memory usage, as shown in the table below.

Pressing the Refresh icon resets the Max Used.

4.2.3.7.3 DISK#

When the cursor is placed on the gauge, the following information is displayed.

The colored portion of the gauge represents disk usage.

The gauge changes color according to the percentage of disk usage, as shown in the table below.

4.2.3.8 Control the selected components#

Control the Selected components is a function that controls the selected components in List Mode. Operations such as start, stop, toggle autostart, toggle simulation mode, and select log level can be performed collectively on the selected components.

4.2.3.8.1 Start#

Starts the selected components collectively. Starts regardless of the autostart setting.

4.2.3.8.2 Stop#

Stops the selected components collectively.

4.2.3.8.3 Enable autostart#

Enables autostart for the selected components collectively.

4.2.3.8.4 Disable autostart#

Disables autostart for the selected components collectively.

4.2.3.8.5 Enable simulation#

Enables simulation for the selected components collectively.

4.2.3.8.6 Disable simulation#

Disables simulation for the selected components collectively.

4.2.3.8.7 Log level#

Changes the log level of the selected components collectively.

4.2.3.9 Component list control#

Component list control is a function that controls components from the component list in List Mode. Operations such as start, stop, log viewing, and editing can be performed on the component list.

4.2.3.9.1 Start#

Starts the component.

4.2.3.9.2 Stop#

Stops the component.

4.2.3.9.3 Log#

Opens the log dialog of the component.

4.2.3.9.4 Status Timeline#

Opens the status timeline dialog of the component.

4.2.3.9.5 Configuration#

Opens the configuration dialog of the component.

4.2.3.9.6 Port settings#

• In port setting Opens the in port setting dialog of the component.

• Out port setting

  Opens the out port setting dialog of the component.

• System port setting

  Opens the system port setting dialog of the component.

4.2.3.10 Simulation mode#

This section describes the simulation mode.

4.2.3.10.1 Outline of simulation mode#

The simulation mode is a function that generates columns based on the contents of a CSV file and registers dummy data. This function enables configurations and operation verification even in an environment where there is no actual opposed equipment (such as PLC). Components that support simulation mode are as follows.

• Modbus Collector
• PLC Collector
• EtherNet/IP Collector
• MQTT Collector

4.2.3.10.2 Configuration and switching of simulation mode#

This section describes using the PLC collector.

1. Click the Simulation settings button in the upper left of the component configuration window.

   

2. The simulation settings window opens. Input configuration items and click "Close".

   

   Item	Description
   Simulation mode	Enable/disable simulation mode
   Operation file (csv)	A CSV file that defines the columns and data used in simulation mode. For detail, see Formatting Driving Files.

   Once a driving file is uploaded, its configurations are retained until deleted.

3. The window returns to the component configuration window. Input component configuration items and click "Save". Changes to simulation settings are not applied until "Save" is clicked on the component configuration screen.

4. Click the Start button to start. The component status light turns blue when the system is running while the simulation mode is ON.

   

4.2.3.10.3 Operation File Format#

The operation file is in CSV format. This consists the header section (the first row) and the data section (the second row onward). The header section defines the columns, while the data section specifies the timestamps and data to register.

timestamp_ms,data1:bool,data2:int32,data3:string,data4:binary
        1000,      true,          1,       test1,    YWl1ZW8=
        2000,     false,          2,       test2,    YWl1ZW8=
        3000,      true,          3,       test3,    YWl1ZW8=

Header section

timestamp_ms,data1:bool,data2:int32,data3:string,data4:binary

• The first row of the header section is fixed as timestamp_ms, and column definitions are input starting from the second row onward.
• Column definitions specify column names and data types separated by a :, such as column name: data type.
• For arrays, the number of arrays is enclosed in [] to specify, such as column name: data type [Array Size].

Data section

        1000,      true,          1,       test1,    YWl1ZW8=
        2000,     false,          2,       test2,    YWl1ZW8=
        3000,      true,          3,       test3,    YWl1ZW8=

• For the first row of the data section, input the value of timestamp_ms, and for the second row and onward, input data values to actually register.
• Data is registered based on the time elapsed from the start to the value of timestamp_ms. In the example of the above CSV, the data is registered at 1,000, 2,000, and 3,000 milliseconds rom the start.
• If timestamp_ms is less than the last value (back in time), no data is registered for that row.
• When the end of the file is reached, data returns to the beginning of the file and is registered from the beginning again.
• If the value of the data is blank, the data is not registered.
• Array data is specified by separating them with spaces.

A sample driving file is shown below.

• All data type sample
• Array data sample

4.2.3.10.4 Operation of simulation mode#

While the system is running on the simulation mode, only the dummy data is registered. The data of communication with actual devices is not collected. As for the component status while the simulation mode is running, the status lamp is shown with blue, but the status is the same as regular Running.

• The registered dummy data can be checked through data monitoring in the same way as normal components.

• Data can also be transferred to a different component by connecting flowlink.

Simulation mode poses no problem when validating data flows during development. However, be sure to turn it OFF when operating in an actual environment.

4.2.3.11 How to operate on a table device#

SpeeDBee Synapse supports operation on a tablet device. The verified tablet devices are as follows.

Some actions on a tablet device differ from operation on a PC using a mouse. The main differences are summarized below.