pydrake.lcm

class pydrake.lcm.DrakeLcm

Bases: pydrake.lcm.DrakeLcmInterface

A wrapper around a real LCM instance.

StartReceiveThread(self: pydrake.lcm.DrakeLcm) → None

(Deprecated.)

Deprecated:
Almost no Drake uses of LCM should require a background thread. Please use DrakeLcmInterface::HandleSubscriptions() or drake::systems::lcm::LcmInterfaceSystem instead. In the unlikely event you really do need a thread, the implementation of Start+Stop+IsRunning is simple; feel free to copy and adapt it, or see https://github.com/RobotLocomotion/drake/pull/11166 for more ideas. This will be removed from Drake on or after 2019-08-01.
StopReceiveThread(self: pydrake.lcm.DrakeLcm) → None

(Deprecated.)

Deprecated:
Almost no Drake uses of LCM should require a background thread. Please use DrakeLcmInterface::HandleSubscriptions() or drake::systems::lcm::LcmInterfaceSystem instead. In the unlikely event you really do need a thread, the implementation of Start+Stop+IsRunning is simple; feel free to copy and adapt it, or see https://github.com/RobotLocomotion/drake/pull/11166 for more ideas. This will be removed from Drake on or after 2019-08-01.
__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pydrake.lcm.DrakeLcm) -> None

Constructs using LCM’s default URL (either the default hard-coded URL, or else LCM_DEFAULT_URL environment variable if it is set).

  1. __init__(self: pydrake.lcm.DrakeLcm, lcm_url: unicode) -> None

Constructs using the given URL. If empty, it will use the default URL as per the no-argument constructor.

class pydrake.lcm.DrakeLcmInterface

A pure virtual interface that enables LCM to be mocked.

Because it must be pure, in general it will receive breaking API changes without notice. Users should not subclass this interface directly, but rather use one of the existing subclasses instead.

Similarly, method arguments will receive breaking API changes without notice. Users should not call this interface directly, but rather use drake::lcm::Publish() or drake::lcm::Subscribe() instead.

HandleSubscriptions(self: pydrake.lcm.DrakeLcmInterface, timeout_millis: int) → int

Invokes the HandlerFunction callbacks for all subscriptions’ pending messages. If timeout_millis is >0, blocks for up to that long until at least one message is handled.

Returns:the number of messages handled, or 0 on timeout.
Raises:RuntimeError when a subscribed handler throws.
Publish(self: pydrake.lcm.DrakeLcmInterface, channel: unicode, buffer: str, time_sec: Optional[float] = None) → None

Most users should use the drake::lcm::Publish() free function, instead of this interface method.

Publishes an LCM message on channel channel.

Parameter channel:
The channel on which to publish the message. Must not be the empty string.
Parameter data:
A buffer containing the serialized bytes of the message to publish.
Parameter data_size:
The length of @data in bytes.
Parameter time_sec:
Time in seconds when the publish event occurred. If unknown, use drake::nullopt or a default-constructed optional.
__init__

x.__init__(…) initializes x; see help(type(x)) for signature

class pydrake.lcm.DrakeMockLcm

Bases: pydrake.lcm.DrakeLcmInterface

A mock LCM instance. This only manipulates LCM messages in memory, not on the wire. It is similar to a DrakeLcm object with a “memq://” URL, but is guaranteed to behave deterministically (without a hidden background thread).

InduceSubscriberCallback(self: pydrake.lcm.DrakeMockLcm, channel: unicode, buffer: str) → None

Fakes a callback. The callback is executed by the same thread as the one calling this method.

Parameter channel:
The channel on which to publish the message.
Parameter data:
A buffer containing the serialized bytes of the message to publish.
Parameter data_size:
The length of @data in bytes. / (Deprecated.)
Deprecated:
Call drake::lcm::Publish() instead. This will be removed from Drake on or after 2019-06-01.
Subscribe(self: pydrake.lcm.DrakeMockLcm, channel: unicode, handler: Callable[[str], None]) → None
__init__(self: pydrake.lcm.DrakeMockLcm) → None

A constructor that creates a DrakeMockLcm with loopback disabled, i.e., a call to Publish() will not result in subscriber callback functions being executed. To enable loopback behavior, call EnableLoopBack().

get_last_published_message(self: pydrake.lcm.DrakeMockLcm, channel: unicode) → str

Obtains the most recently “published” message on a particular channel. A RuntimeError will be thrown if no message was published on the provide channel.

Parameter channel:
The channel on which the LCM message was published.
Returns:A reference to a vector containing the serialized bytes of the LCM message that was previously published on channel channel.
Precondition:
A message was previously published on channel channel. / (Deprecated.)
Deprecated:
Use a drake::lcm::Subscriber instead. This will be removed from Drake on or after 2019-06-01.
class pydrake.lcm.Subscriber(lcm, channel, lcm_type)

Subscribes to and stores a copy of the most recent message on a given channel, for some message type. This class does NOT provide any mutex behavior for multi-threaded locking; it should only be used in cases where the governing DrakeLcmInterface.HandleSubscriptions is called from the same thread that owns all copies of this object.

__init__(lcm, channel, lcm_type)

Creates a subscriber and subscribes to channel on lcm.

Parameters:
  • lcm – LCM service instance (a pydrake.lcm.DrakeLcmInterface).
  • channel – LCM channel name.
  • lcm_type – Python class generated by lcmgen.
clear()