Metadata-Version: 2.1
Name: DobotRPC
Version: 3.0.0
Summary: Dobotlink communication module
Home-page: UNKNOWN
Author: JoMar Wu
Author-email: songlijun@dobot.cc
License: Apache Licence
Description: 
        ***This version is relevant for Dobotlink 3.2.1.*** 
        
        DobotRPC is a dobotlink communication module based on websocket and JSON-RPC . It provides python ports to communicate with dobotlink and allows developers to communicate with the GUI. Here is a more detailed list of the package contents:
        
        ###### Network
        
        - The file contains both RPCClient and RPCServer files that users can call upon their own needs
        - DobotlinkAdapter: The adapter module is used to adapt to the new set of interfaces
        
        ###### Utils
        
        - Loggers: Loggers information
        
        ## Installtion
        
        To install DobotRPC, type:
        ```
        pip install DobotRPC
        ```
        DobotRPC is a free software distributed under the Apache license
        
        ## Usage
        
        #### Examples
        
        - Users can communicate synchronously or asynchronously.The asynchronous mode is as follows:
        ```python
        # Async demo
        from DobotRPC import DobotlinkAdapter, RPCClient
        # The asyncio module provides infrastructure for writing single-threaded concurrent code using coroutines, multiplexing I/O access over sockets and other resources, running network clients and servers, and other related primitives.
        import asyncio
        
        
        # Coroutines function
        async def main(dobotlink_async):
            # Display information with Dobotlink
            await dobotlink_async.api.ShowMessage(title="Async Demo Message",
                                                  message="Async Demo is running.")
        
            # Search for available ports
            res = await dobotlink_async.Magician.SearchDobot()
        
            # Get ports
            if len(res) < 1:
                return
            port = res[0]["portName"]
        
            # Connect
            await dobotlink_async.Magician.ConnectDobot(portName=port)
        
            # PTP
            await dobotlink_async.Magician.SetPTPCmd(portName=port,
                                                     ptpMode=0,
                                                     x=230,
                                                     y=50,
                                                     z=0,
                                                     r=20)
            # Disconnect
            await dobotlink_async.Magician.DisconnectDobot(portName=port,
                                                           queueStop=True,
                                                           queueClear=True)
        
        
        if __name__ == "__main__":
        '''
            The log prints info information by default, which can be modified by the user
            Log levels include:NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL
        '''
            loggers.set_level(loggers.DEBUG)
            # Get the Eventloop reference
            loop = asyncio.get_event_loop()
            # Initializes, connects to dobotlink, and is executed before the Loop runs
            dobotlink_async = DobotlinkAdapter(RPCClient(loop=loop), is_sync=False)
            # Perform coroutines
            loop.run_until_complete(main(dobotlink_async))
        ```
        - The synchronization mode is as follows:
        
        ```python
        
        # Sync Demo
        from DobotRPC import RPCClient, DobotlinkAdapter
        
        
        def main(dobotlink_sync):
            # Display information with Dobotlink
            dobotlink_sync.api.ShowMessage(title="Sync Demo Message",
                                           message="Sync Demo is running.")
        
            # Search for available ports
            res = dobotlink_sync.Magician.SearchDobot()
        
            # Get ports
            if len(res) < 1:
                return
            port = res[0]["portName"]
        
            # Connect
            dobotlink_sync.Magician.ConnectDobot(portName=port)
        
            # PTP
            dobotlink_sync.Magician.SetPTPCmd(portName=port,
                                              ptpMode=0,
                                              x=230,
                                              y=50,
                                              z=0,
                                              r=20)
        
            # Disconnect
            dobotlink_sync.Magician.DisconnectDobot(portName=port)
        
        
        if __name__ == "__main__":
        '''
            The log prints info information by default, which can be modified by the user.
            Log levels include:NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL
        '''
            loggers.set_level(loggers.DEBUG)
            # Initialize, connect to dobotlink
            dobotlink_sync = DobotlinkAdapter(RPCClient(), is_sync=True)
        
            main(dobotlink_sync)
        ```
        - Open Dobotlink
        - Connect device
        - Run python examples
Keywords: websocket,JSON-RPC,asyncio,Dobot,Dobotlink
Platform: any
Description-Content-Type: text/markdown
