Log Annotation

Client for the log-annotation service (DEPRECATED).

The log-annotation service is deprecated and will be removed in a later release. Instead, please use the data_buffer service going forward.

exception bosdyn.client.log_annotation.InvalidArgument

Bases: Error

A given argument could not be used.

class bosdyn.client.log_annotation.LogAnnotationClient(*args, **kwargs)

Bases: BaseClient

A client for adding annotations to robot logs.

Deprecated since version 2.1.0: The log-annotation client and service have been replaced by data_buffer.

default_service_name = 'log-annotation'

service_type = 'bosdyn.api.LogAnnotationService'

update_from(other)

Adopt key objects like processors, logger, and wallet from other.

add_text_messages(text_messages, **kwargs)

Log text messages to the robot.

Parameters:

text_messages – Sequence of LogAnnotationTextMessage protos.

Raises:

RpcError – Problem communicating with the robot.

add_text_messages_async(text_messages, **kwargs)

Async version of add_text_messages.

add_operator_comment(msg, robot_timestamp=None, **kwargs)

Add an operator comment to the robot log.

Parameters:

• msg – Text of user comment to log.

• robot_timestamp – Time (google.protobuf.Timestamp) of messages, in robot time. If not set, timestamp will be when the robot receives the message.

Raises:

RpcError – Problem communicating with the robot.

add_operator_comment_async(msg, robot_timestamp=None, **kwargs)

Async version of add_operator_comment.

add_log_blob(data, type_id, channel=None, robot_timestamp=None, **kwargs)

Log blob messages to the robot.

Parameters:

• data – Binary data of one blob.

• type_id – Type of binary data of blob.

• robot_timestamp – Time (google.protobuf.Timestamp) of messages, in robot time. If not set, timestamp will be when the robot receives the message.

Raises:

RpcError – Problem communicating with the robot.

add_log_blob_async(data, type_id, channel=None, robot_timestamp=None, **kwargs)

Async version of add_log_blob.

add_log_protobuf(proto, robot_timestamp=None)

add_log_protobuf_async(proto, robot_timestamp=None)

class bosdyn.client.log_annotation.LogAnnotationHandler(*args, **kwargs)

Bases: Handler

A logging system Handler that publish to a bosdyn.api.LogAnnotationService (DEPRECATED).

LogAnnotationHandler is deprecated. Instead, use bosdyn.client.data_buffer.LoggingHandler.

Deprecated since version 2.1.0: The log-annotation client and service have been replaced by data_buffer.

emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

flush()

Ensure all logging output has been flushed.

This version does nothing and is intended to be implemented by subclasses.

close()

Tidy up any resources used by the handler.

This version removes the handler from an internal map of handlers, _handlers, which is used for handler lookup by name. Subclasses should ensure that this gets called from overridden close() methods.

is_thread_alive()

restart(log_client)

Restart the send thread.

Raises:

AssertionError if send thread is still alive. –

fallback_log(msg)

record_to_msg(record)

static record_level_to_proto_level(record_level)