Skip to main content

Get intellisense for ROS 2 interfaces

Project description

common-interfaces-intellisense

Get intellisense for ROS 2 messages. Services are not supported. This is a only intended to be used for intellisense purposes. Useful if developing on another system than where ROS 2 is available (Docker for example). Code within this package is NOT intended to be ran.

Installation

pip install common-interfaces-intellisense

Usage

from geometry_msgs.msg import Quaternion
from std_msgs.msg import String

# will now get intellisense
msg = Quaternion()

# or
msg = String(data="my string")

Here is an example of a generated class:

sensor_msgs/msg/CameraInfo.py

# flake8: noqa
from common_interfaces.base_types import *
from std_msgs.msg import Header
from . import RegionOfInterest

from typing import Any


class CameraInfo:
    """
    https://github.com/ros2/common_interfaces/blob/humble/sensor_msgs/msg/CameraInfo.msg

    Args:
        header: No information
        height: No information
        width: No information
        distortion_model: No information
        d: No information
        k: 9 elements
        r: 9 elements
        p: 12 elements
        binning_x: No information
        binning_y: No information
        roi: No information
    """
    def __init__(
        self,
        header: Header | Any = None,
        height: uint32 | int = None,
        width: uint32 | int = None,
        distortion_model: string | str = None,
        d: list[float64] | list[float] = None,
        k: list[float64] | list[float] = None,
        r: list[float64] | list[float] = None,
        p: list[float64] | list[float] = None,
        binning_x: uint32 | int = None,
        binning_y: uint32 | int = None,
        roi: RegionOfInterest | Any = None,
    ):
        self.header: Header | Any
        self.height: uint32 | int
        self.width: uint32 | int
        self.distortion_model: string | str
        self.d: list[float64] | list[float]
        self.k: list[float64] | list[float]
        self.r: list[float64] | list[float]
        self.p: list[float64] | list[float]
        self.binning_x: uint32 | int
        self.binning_y: uint32 | int
        self.roi: RegionOfInterest | Any

Build

from common_interfaces.build import BuildInterfaces

BuildInterfaces().build()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

common_interfaces_intellisense-0.1.0.tar.gz (114.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file common_interfaces_intellisense-0.1.0.tar.gz.

File metadata

File hashes

Hashes for common_interfaces_intellisense-0.1.0.tar.gz
Algorithm Hash digest
SHA256 033b99431987609ea9d5f6800994fa7f6983a09820197fdf8223936a75d7f360
MD5 7bc44b7082ec5bdd1fd3b79668b42617
BLAKE2b-256 4dc6e49272a18318b9c6a119be3f25d0b6adac903e68384f0369599d1a12b302

See more details on using hashes here.

File details

Details for the file common_interfaces_intellisense-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for common_interfaces_intellisense-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f2e7bdb0fdb6013fbe1d809da8f50730e2108b7859ffb28817e90c51373e326
MD5 6724362f022a252777fff4554ac65bf9
BLAKE2b-256 a3133e6d8ec22a5d4a794a42b65193be8519d416c69bddb648df92b6b0c6104a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page