search

mcsix / xela_server_ros

ROS Node for XELA Sensors (ROS 1)
MIT License
3 stars 1 forks source link

readme

ROS Node for XELA Sensors (ROS 1)

Disclaimer

This Node is for ROS 1 and will not work with ROS 2. For ROS 2, please use the ROS Node for XELA Sensors (ROS 2).

License

This ROS 1 node package is provided as-is under the terms of the MIT License.

MIT License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Function overview

This node takes all information provided by the XELA Server application and broadcasts it via services and a publisher node to the ROS 1 network.

Services

Service: xServStream

The xServStream service provided by the XELA Sensors ROS 1 node package allows users to request sensor data from the XELA Server application within the ROS network. This service can be used to retrieve information about one or more sensors connected to the XELA sensor array.

Service Request

Service Response

The response from the xServStream service will contain information about the requested sensor(s) in the form of ROS 1 messages. Each sensor's data is encapsulated in a xela_server_ros.msg.SensorFull message, which includes the following information:

In case there is no valid data for the requested sensor(s), or if no sensor data is available at all when requesting data from all sensors, the response will contain a default sensor message with the model name set to "not_available", and no taxels nor forces present.

Note: As only some sensors support forces, in case the user uses unsupported sensors, the forces list will be empty. The same applies if they have not enabled it in the xServ.ini file within the XELA Suite.

Example Usage

To test the xServStream service, you can use the ros service call command in a terminal. Here are some example usage scenarios:

rosservice call /xServStream 1
rosservice call /xServStream 0

Note: the 0 must be specified, as ROS 1 requires it.

These commands will return the latest sensor data, and the response will include the details described above. For an example, the following is the response of the sensor if there are no details about it:

data: 
  - 
    message: 0
    time: 0.0
    model: "not_available"
    sensor_pos: 0
    taxels: []
    forces: []

In case there is valid data for the requested sensor or all sensors, the response will contain following details:

data: 
  - 
    message: 4507
    time: 1696911224.9756384
    model: "uSPa44"
    sensor_pos: 1
    taxels: 
      - 
        x: 33270
        y: 31184
        z: 30012
      ...
    forces: 
      - 
        x: -0.799458384513855
        y: 0.9535559415817261
        z: 1.0565017461776733
      ...
  ...

Note: in case of specific sensor, the response will contain only one (the requested) sensor message in the list. There is no limit to how many sensors there can be.

Topics / Publishers

Publisher: xServTopic

The xServTopic publisher within the XELA Sensors ROS 2 node package broadcasts sensor data to the ROS 2 network. This data is continuously published to the specified topic, and subscribers can listen to this topic to receive sensor information.

Published Topic

Published Data The data published by the xServTopic publisher consists of sensor information encapsulated in ROS 2 messages of type xela_server_ros.msg.SensStream. Each message contains the following details:

Example Usage Subscribers can listen to the /xServTopic topic to receive real-time sensor data. You can create ROS 1 nodes or applications that subscribe to this topic to access and process the sensor information.

By subscribing to this topic, users can access the latest data from all available sensors, making it a valuable resource for integrating XELA Sensors into ROS 2 applications.

Users can also access the stream in terminal with the following command:

rostopic echo /xServTopic

The response will look like the following:

sensors:
- message: 5548
  time: 1695696620.8967698
  model: uSPa44
  sensor_pos: 1
  taxels:
  - 
    x: 49331
    y: 17509
    z: 37365
  ...
  forces:
  - 
    x: -0.13371588289737701
    y: -0.10482559353113174
    z: 5.396903038024902
  ...
...
---

Each packet might contain several sensors, each of which contains several taxels and forces. Each will also contain message number, initial broadcast time and sensor position defined for better tracking.

Components

Messages

xela_server_ros.msg.SensorFull

xela_server_ros.msg.Taxel

xela_server_ros.msg.Forces

xela_server_ros.msg.SensStream

Services

xela_server_ros.srv.XelaSensorStream

Example code

Service (Single update)

#!/usr/bin/env python3
import rospy
from xela_server_ros.srv import XelaSensorStream

class MinimalClient(object):

    def __init__(self):
        rospy.init_node('minimal_client')
        self.client = rospy.ServiceProxy('xServStream', XelaSensorStream)
        rospy.wait_for_service('xServStream')

    def send_request(self, sensor):
        try:
            response = self.client(sensor)
            return response
        except rospy.ServiceException as e:
            rospy.logerr("Service call failed: %s" % e)

def main():
    minimal_client = MinimalClient()
    response = minimal_client.send_request(1)  # Change to the sensor needed or 0 for all
    rospy.loginfo("Result of XelaSensorStream: %s", response)
    rospy.loginfo("X of the first taxel of the first sensor returned: %s", response.data[0].taxels[0].x)

if __name__ == '__main__':
    main()

Topic (Stream)

#!/usr/bin/env python3
import rospy
from xela_server_ros.msg import SensStream

class MinimalSubscriber(object):

    def __init__(self):
        rospy.init_node('minimal_subscriber')
        self.subscriber = rospy.Subscriber('xServTopic', SensStream, self.listener_callback)

    def listener_callback(self, msg):
        sensors = msg.sensors
        rospy.loginfo("-------------------------")
        rospy.loginfo("Broadcast: %s sensor(s)", len(sensors))
        for sensor in sensors:
            rospy.loginfo("Model `%s` at message `%s` with %d taxels and %s calibration",
                          sensor.model, sensor.message, len(sensor.taxels) / 3,
                          "with" if sensor.forces else "without")

def main():
    minimal_subscriber = MinimalSubscriber()
    rospy.spin()

if __name__ == '__main__':
    main()

Installation

Prerequisites

Installation

  1. Install the XELA software on your computer and add to your $PATH
  2. Install Python 3 on your computer (if not done yet)
  3. Install ROS 1 on your computer (if not done yet) a) If your ROS installation is not configured for Python 3, you must do so manually. See Transitioning to Python 3 for more information.
  4. cd {your_ros_workspace}/src
  5. Clone this repository to your computer sh git clone https://github.com/mcsix/xela_server_ros.git
  6. Run the following command to build the ROS 1 node package: 
    catkin_make
  7. Run the following command to source the ROS 1 node package: 
    source devel/setup.bash
  8. Run the following command to start the ROS 1 node: 
    roslaunch xela_server_ros service.launch
  9. Set up your node or test out cli commands shown above

Troubleshooting

Getting help

XELA Suite

ROS 1

XELA Sensors ROS 1 Node

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Contributors

Photo Contributor Relation
@mcsix Author