Ricoh SC-10 SERIES User manual

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 1/66
INSPECTION CAMERA SYSTEM
RICOH SC-10 SERIES
Socket Mode Function Operating Instructions
RICOH Industrial Solutions Inc.

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 2/66
How to Read This Manual
About Symbols
The symbols used in this manual have the following meanings.
Indicates an explanation containing points to pay attention to when operating the device, restrictions, or other information.
Be sure to read the explanation.
Indicates an explanation containing information that is useful to know, a supplementary operating procedure, or other
information.
/(→P. ##)
Indicates reference information.
［］
Indicates a screen item or button name.

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 3/66
Contents
OVERVIEW..................................................................................................................................................................4
Applicable Devices and Connection Configuration ......................................................................................................4
Applicable models ...................................................................................................................................................4
Connection configuration.........................................................................................................................................4
SOCKET MODE ..........................................................................................................................................................5
Enabling the Socket Mode Control Function................................................................................................................5
Setting the Debug Mode...............................................................................................................................................6
Status Transition Diagram............................................................................................................................................7
Sequences....................................................................................................................................................................8
Processing at startup...............................................................................................................................................8
Logout......................................................................................................................................................................8
Status check............................................................................................................................................................9
Work item list acquisition.........................................................................................................................................9
Work ID execution processing...............................................................................................................................10
Work ID switching and start processing ................................................................................................................10
External IO (OUT) link ...........................................................................................................................................11
Matching of multiple work items of one work ID....................................................................................................12
Stopping work item (TCP/IP).................................................................................................................................13
Message crossing (stop request) ..........................................................................................................................14
Start request timeout.............................................................................................................................................15
Work item completed notification response timeout..............................................................................................15
MESSAGE IDS ..........................................................................................................................................................16
Socket Mode Message IDs.........................................................................................................................................16
Message Headers.......................................................................................................................................................17
Message ID (Request Message: Other Device → SC-10A).......................................................................................18
Message ID (Notification Message Response: Other Device → SC-10A).................................................................26
Message ID (Request Response Message: SC-10A → Other Device) .....................................................................32
Message ID (Notification Message: SC-10A → Other Device) ..................................................................................40
ERROR CODE...........................................................................................................................................................52
SAMPLE CODE.........................................................................................................................................................55
C Language ................................................................................................................................................................55
Send program........................................................................................................................................................55
Receive program ...................................................................................................................................................58
C# ...............................................................................................................................................................................60
Send program........................................................................................................................................................60
Receive program ...................................................................................................................................................62
FLOW CHARTS.........................................................................................................................................................64

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 4/66
Overview
The inspection camera system (SC-10A series) can be connected with an external device using the TCP/IP socket mode
function.
This manual describes the connection procedure for socket mode and the data formats to set for socket mode.
Applicable Devices and Connection Configuration
Applicable models
The following devices support socket mode.
Inspection camera system: SC-10A (Ver. 4.0.0 or later)
Inspection camera system: SC-10A (H) (Ver. 4.0.0 or later)
Connection configuration
If Ethernet connections are used, multiple inspection camera systems can be connected.
Example 1:
Example 2:
Ethernet connection
Multiple devices
can be connected.
Multiple SC-10A can be
managed with another device.
Other device
Other device
SC-10A (#1)
SC-10A (#2)
SC-10A (#3)
SC-10A (#4)
SC-10A (#n)
SC-10A

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 5/66
Socket Mode
Enabling the Socket Mode Control Function
Set the socket mode control function of the SC-10A in the [Settings] screen of the SC-10A.
Log in to the SC-10A in the administrator mode and then select [Job Settings...] in the [Job] menu to display the [Settings]
screen.
For details on operation of the SC-10A, refer to the operating instructions of the SC-10 series.
1. Select [Socket Mode].
2. Select the [Enable Socket Mode] check box.
3. Set the IP address of the other device (other party with which to perform socket mode)
in [Destination IP Address].
4. Enter the name of the device in [Device Name].
Enter any name from 1 to 50 half-width alphanumeric characters long.
5. Click [Save].
The settings are saved.
[Device ID] is set automatically by the system.
1
2
3
4
5

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 6/66
Setting the Debug Mode
The debug mode can be set. When developing an application for the other device, you can use the debug mode to check
communication and verify operation.
To set debug mode, you need to enable the socket mode function in advance (
→P.5
).
1. Select [Debug Mode] in the socket mode settings screen.
2. Click [Save].
When the debug mode is enabled, the logs of sent and received messages (date and time sent/received, message ID,
sent/received information, and error code) are displayed in the log display area. If you click [Save Log], you can save
the logs to media.
If you select a message to send to the other device from the pull-down menu and then click the [Test] button, the
message is sent.
Send a message to
the other device.
Save the log data.
2
Log display area
1

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 7/66
Status Transition Diagram
Prepare to start
Wait to log in
Transferring
work item
Startup
notification
response
Start work ID
Timeout
Executing work
ID
Work ID
completed
Executing work
item
Logout
notification
response
Login
notification
response
Work item list
acquisition
request
Acquisition completed response
Work ID execution
request
Work ID start request
Work ID completed
notification (T.O)
Timeout
Work ID completed response
Timeout
Work item
completed
response
Stop request
Work item completed response
Stop request
Start request
Idle
Start request

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 8/66
Sequences
This section describes the sequences supposed to be used with the work instruction network control function.
Processing at startup
The SC-10A sends a startup notification to the other device after startup. The application of the other device sends a
startup notification response after receiving the startup notification.
The SC-10A sends the login information in a login notification after receiving the startup notification response. The other
device sends a login notification response and the sequence ends.
Startup notification (when successful):
Logout
When the logout operation is performed, the SC-10A sends a logout notification.
The other device sends a logout notification response and the sequence ends.
SC-10A 対向機
起動通知
起動通知応答
ログイン通知
ログイン通知応答
SC-10A 対向機
ログアウト通知
ログアウト通知応答
Other device
Startup notification
Startup notification response
Login notification response
Login notification
SC-10A
Other device
Login notification
Login notification response
SC-10A

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 9/66
Status check
When the status of the SC-10A is checked from the other device, a status check request is sent from the other device.
The status of the camera is sent as a status check response at arbitrary timing.
Work item list acquisition
When a work item registered on the SC-10A is acquired, a work item list acquisition request is sent from the other device.
The SC-10A sends a work item list response and then sends work item list data notifications.
One work item list data notification is sent per work item registered on the SC-10A. When sending of the work item list data
notifications for all of the work items is complete, the work item list acquisition completed notification is sent. The other
device sends a work item list acquisition completed response and the sequence ends.
SC-10A 対向機
状態確認要求
状態確認応答
SC-10A 対向機
作業Itemリスト取得要求
作業Itemリストデータ通知
作業Itemリストデータ通知
作業Itemリスト取得完了通知
作業Itemリストデータ通知
作業Itemリストデータ通知
作業Itemリストデータ通知
作業Itemリスト取得完了応答
作業Itemリスト取得応答
Notifications are
sent for all of the
held work items.
Other device
Status check request
Status check response
SC-10A
Other device
Work item list acquisition request
Work item list data notification
Work item list data notification
Work item list data notification
Work item list data notification
Work item list data notification
Work item list acquisition
completed notification
Work item list acquisition
completed response
Work item list acquisition
response
SC-10A

RICOH SC-10 SERIES
Socket Mode Function Operating Instructions Ver.1.0.0 10/66
Work ID execution processing
When the work ID of the SC-10A is switched from the other device to execute the sequence starting with the first work item
registered to the work ID, a work ID execution request is sent from the other device. The work items are executed
sequentially from the first one registered to the work ID. The execution result is sent in a work item completed notification
from the SC-10A.
When execution of all work items registered to the work ID is completed, the SC-10A sends a work ID completed
notification. The other device sends a work ID completed response to the SC-10A and the sequence ends.
Work ID switching and start processing
When the work ID switching and start processing is executed from the other device, a work ID start request is sent from the
other device. The SC-10A sends a work ID start response. If there is no problem with the response result, the other device
sends a start request. If there is no problem with the start response from the SC-10A, the other device waits for a work item
completed notification sent from the SC-10A after the work item execution completes. When the work item completed
notification is received, a work item completed response is sent from the other device. When all work items of the work ID
are completed, the SC-10A sends a work ID completed notification. The other device sends a work ID completed response
and the sequence ends.
SC-10A 対向機
作業Item完了通知(マッチング)
作業Item完了応答
作業ID実行要求
作業ID実行応答
作業ID完了通知
作業ID完了応答
SC-10A 対向機
Start要求
Start応答
作業Item完了通知(マッチング)
作業Item完了応答
作業ID開始要求
作業ID開始応答
作業ID完了通知
作業ID完了応答
Other device
Work ID execution request
Work ID execution response
Work item completed notification
(matching)
Work item completed response
Work ID completed notification
Work ID completed response
SC-10A
Other device
Work ID start request
Work ID start response
Start request
Start response
Work item completed notification
(matching)
Work item completed response
Work ID completed notification
Work ID completed response
SC-10A