Other Interfaces

This guide introduces other interfaces of Adapter, as listed below.

Notify Service

When a Mech-Viz project proceeds to a particular branch or Step, and a corresponding function in Adapter program needs to be called, you can add a Notify Step in the Mech-Viz project.

Example

For example, a function is written to increase the number of depalletized items in the Adapter program. Then we can add a Notify Step after the last Step of the depalletizing process. When the project executes to the Notify Step, the Adapter can be triggered to call the function. The example function is shown below.

Create a class that inherits the parent class NotifyService.

from interface.services import NotifyService, register_service

class NotifyService(NotifyService):
    service_type = "notify"
    service_name = "FANUC_M410IC_185_COMPACT"

    def __init__(self, update_success_num, update_fail_num):
        self.update_success_num = update_success_num
        self.update_fail_num = update_fail_num

    def handle_message(self, msg):
        if msg == "Success":
            self.update_success_num()
        elif msg == "Fail":
            self.update_fail_num()

When Mech-Viz executes the Notify Step and a message “Success” is sent, the Adapter will call the update_success_num() function; while a message “Fail” will trigger the Adapter to call the update_fail_num() function.

Instantiate the NotifyService class and register the service in the class that controls the main program of Mech-Viz.

class MyClient(TcpClientAdapter):

     def __init__(self, host_address):
         super().__init__(host_address)
         self._register_service()

     def _register_service(self):
         self.robot_service = NotifyService(self.update_success_num, self.update_fail_num)
         self.server, port = register_service(self.hub_caller, self.robot_service)

     def update_success_num(self):
         # the num of unstack successfully plus 1
         self.success_num += 1

     def update_fail_num(self):
         # the num of unstack fiplus 1
         self.fail_num += 1

Add Notify Step in a proper position in the workflow of Mech-Viz.

Note that the Adapter Name and Message parameters in the “Notify” Step correspond to the “service_name” and “msg” attributes in the NotifyService class. Ensure the parameter values are set to the same ones as the attributes.

Once the project is executed, if the notify service is successfully registered, “service_type” and “service_name” will be displayed in the Console tab of the log panel in Mech-Vision.

VisionWatcher Service

After Mech-Vision finishes running, some results will be output, such as vision result: False, ‘function’: ‘posesFound’, ‘vision_name’: ‘TJTvision-3’}. If some issues occur, Adapter can send out error messages via the VisionWatcher service.

Example

Create a class that inherits the class VisionResultSelectedAtService.

from interface.services import VisionResultSelectedAtService, register_service

class VisionWatcher(VisionResultSelectedAtService):
    def __init__(self, send_err_no_cloud):
        super().__init__()
        self.send_err_no_cloud = send_err_no_cloud

    def poses_found(self,result):
        has_cloud_in_roi = not result.get("noCloudInRoi", False)

        if not has_cloud_in_roi:
            time.sleep(2)
            self.send_err_no_cloud()

The child class VisionWatcher needs to override the poses_found() function of the parent class, so the logic of calling the function send_err_no_cloud() that sends error messages in Adapter will be changed in poses_found(). During operation, the value of vision points returned by Mech-Vision will be passed to the parameter result in poses_found().

Instantiate the VisionWatcher in the class that controls the main program of Mech-Viz.
```
class MyClient(TcpClientAdapter):
    def __init__(self, host_address):
        super().__init__(host_address)
        self._register_service()
    def _register_service(self):
        self.robot_service = VisionWatcher(self.send_err_no_cloud)
        self.server, port = register_service(self.hub_caller, self.robot_service)

    def send_err_no_cloud(self):
        # send no cloud error message
        self.send("12,NoCloudErr,done".encode())
```
During the instantiation of VisionWatcher class, the send_err_no_cloud() function is passed to VisionWatcher() as a parameter. When there are no point clouds, according to the logic in poses_found(), the function that sends error messages will be called.

After the project begins to run, if the VisionWatcher service is successfully registered by Adapter, it will be displayed in the Console tab of the log panel in Mech-Vision.

Other Interfaces

Notify Service

VisionWatcher Service

We Value Your Privacy