github.com/lugu/qiloop
Package qiloop is an implementation of the protocol QiMessaging used to interract with the NAO and Pepper robots. QiMessaging is a software bus which exposes services. Services have methods (to be called), signals (to be watched) and properties (signals with state). A naming service (the service directory) is used to discover and register services. For a detailed description of the protocol, please visit https://github.com/lugu/qiloop/blob/master/doc/about-qimessaging.md To connect to a service, a Session object is required: it represents the connection to the service directory. Several transport protocols are supported (currently TCP, TLS and UNIX socket). With a session, one can request a proxy object representing a remote service. The proxy object contains the helper methods needed to make the remote calls and to handle the incomming signal notifications. Services have methods, signals and properties which are described in an IDL (Interface Description Language) format. This IDL file is process by the `qiloop` command to generate the Go code which allow remote access to the service (i.e. the proxy object). For example, here is an IDL file which describes a service which have two methods, one signal and one property: Use 'qiloop proxy' commmand to generate the go code which gives access to the service: The file proxy_gen.go contains a method called Services which gives access to the RoboticService service. The example bellow illustrate this. In order to communicate with an existing service for which the IDL file is unknown, the `scan` command can be use to introspect a running instance of the service and generate its IDL description. The following produce the IDL file of LogManager service: In order to implement a new service, create an IDL file and run the `stub` command to generate the helper method to register the service: The file stub_gen.go defines the interface to implement as well as the helper methods to register the service. When offering a service, a Server is be used to handle incomming connection and to dispatch the requests. The actual implementation of a service is provided by a object (Actor interface) which responds to call requests and emits the signals. This example llustrates how to make a method call to a remote object. It uses the specialized proxy of the text to speech service.
Readme
QiMessaging is a network protocol used to build rich distributed applications. It is created by SoftBank Robotics and is the foundation of the NAOqi SDK and the Pepper SDK.
libqi is the implementation of QiMessaging used in Pepper and NAO. It is open-source and developped here: https://github.com/aldebaran/libqi.
For an in-depth overview of the protocol, visit this description of QiMessaging.
QiLoop is another implementation of QiMessaging. It has two main goals:
Disclaimer: QiLoop is not affiliated with SoftBank Robotics.
Read the FAQ.
Client and server sides are functional.
Service directory and log manager are implemented as part of the
standalone server (launched with qiloop server).
Features:
type supported: object, struct, values, map, list, tuple
actions: method, signals and properties are fully supported
cancel: client support only (see motion example)
transport: TCP, TLS, UNIX socket
authentication: read the credentials from $HOME/.qiloop-auth.conf
service introspection: generate IDL from a running instance (use qiloop scan)
IDL files: generate specialized proxy and service stub (use qiloop stub)
stats and trace support
QiMessaging exposes a software bus to interract with services. Services have methods (to be called), signals (to be watched) and properties (signals with state). A naming service (the service directory) is used to discover and register services.
To connect to a service, a Session object is required: it represents the connection to the service directory. Several transport protocols are supported (TCP, TLS and UNIX socket).
With a session, one can request a proxy object representing a remote service. The proxy object contains the helper methods needed to make the remote calls and to handle the incomming signal notifications.
Services have methods, signals and properties which are described in an IDL
(Interface Description Language) format. This IDL file is process by the
qiloop command to generate the Go code which allow remote access to the
service (i.e. the proxy object).
Installation:
go get -u github.com/lugu/qiloop/...
Documentation: http://godoc.org/github.com/lugu/qiloop
How to create a proxy to an existing service: follow the ALVideoDevice tutorial.
How to create your own service: follow the clock tutorial.
Basic examples:
hello world illustrates how to call a method of a service: this example calls the method 'say' of a text to speech service.
signal registration illustrates how to subscribe to a signal: this example prints a log each time a service is added to the service directory.
Examples for NAO and Pepper:
animated say uses ALAnimatedSpeech to animate the robot.
posture puts the robot in a random position.
motion move the robot forward and demonstrate how to cancel a call.
memory uses ALMemory to react on a touch event.
Examples of service implementation:
ping pong service illustrates how to implement a service.
space service illustrates the client side objects creation.
clock service completed version of the clock tutorial.
$ qiloop -h /home/ludo/qiloop
qiloop - an utility to explore QiMessaging
___T_
| 6=6 |
|__`__|
.-._/___\_.-.
; \___/ ;
]| |[
[_| |_]
Usage:
qiloop [info|log|scan|proxy|stub|server|trace]
Subcommands:
info - Connect a server and display services info
log - Connect a server and prints logs
scan - Connect a server and introspect a service to generate an IDL file
proxy - Parse an IDL file and generate the specialized proxy code
stub - Parse an IDL file and generate the specialized server code
server - Starts a service directory and a log manager
trace - Connect a server and traces services
Flags:
--version Displays the program version string.
-h --help Displays help with available flag, subcommand, and positional value parameters.
If you need to provide a login and a password to authenticate yourself
to a server, create a file $HOME/.qiloop-auth.conf with you login on the
first line and your password on the second.
FAQs
Package qiloop is an implementation of the protocol QiMessaging used to interract with the NAO and Pepper robots. QiMessaging is a software bus which exposes services. Services have methods (to be called), signals (to be watched) and properties (signals with state). A naming service (the service directory) is used to discover and register services. For a detailed description of the protocol, please visit https://github.com/lugu/qiloop/blob/master/doc/about-qimessaging.md To connect to a service, a Session object is required: it represents the connection to the service directory. Several transport protocols are supported (currently TCP, TLS and UNIX socket). With a session, one can request a proxy object representing a remote service. The proxy object contains the helper methods needed to make the remote calls and to handle the incomming signal notifications. Services have methods, signals and properties which are described in an IDL (Interface Description Language) format. This IDL file is process by the `qiloop` command to generate the Go code which allow remote access to the service (i.e. the proxy object). For example, here is an IDL file which describes a service which have two methods, one signal and one property: Use 'qiloop proxy' commmand to generate the go code which gives access to the service: The file proxy_gen.go contains a method called Services which gives access to the RoboticService service. The example bellow illustrate this. In order to communicate with an existing service for which the IDL file is unknown, the `scan` command can be use to introspect a running instance of the service and generate its IDL description. The following produce the IDL file of LogManager service: In order to implement a new service, create an IDL file and run the `stub` command to generate the helper method to register the service: The file stub_gen.go defines the interface to implement as well as the helper methods to register the service. When offering a service, a Server is be used to handle incomming connection and to dispatch the requests. The actual implementation of a service is provided by a object (Actor interface) which responds to call requests and emits the signals. This example llustrates how to make a method call to a remote object. It uses the specialized proxy of the text to speech service.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.