Skip to content

blueye.sdk.utils

utils

Classes:

  • deprecated_property –

    Property shim that warns and delegates to the new getter/setter methods.

Functions:

deprecated_property 

deprecated_property(
    fget: str,
    fset: Optional[str] = None,
    doc: Optional[str] = None,
)

Property shim that warns and delegates to the new getter/setter methods.

fget/fset are the names of the replacement methods on the owning class. This is always a data descriptor (it defines __set__) so that assignments to read-only deprecated properties raise an AttributeError instead of silently shadowing the descriptor with an instance attribute.

Source code in blueye/sdk/utils.py 
33
34
35
36
def __init__(self, fget: str, fset: Optional[str] = None, doc: Optional[str] = None):
    self.fget = fget
    self.fset = fset
    self.__doc__ = doc

deserialize_any_to_message 

deserialize_any_to_message(
    msg: Any,
) -> Tuple[MessageMeta, Message]

Deserialize a protobuf Any message to a concrete message type.

Parameters:

  • msg (Any) –

    The Any message to deserialize. Needs to be a message defined in the blueye.protocol package or a well-known-type (FloatValue, Int32Value, etc) from google.protobuf.wrappers_pb2

Returns:

  • Tuple[MessageMeta, Message] –

    A tuple with the message type and the deserialized message.

Source code in blueye/sdk/utils.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def deserialize_any_to_message(msg: Any) -> Tuple[proto.message.MessageMeta, proto.message.Message]:
    """Deserialize a protobuf Any message to a concrete message type.

    Args:
        msg (Any): The Any message to deserialize. Needs to be a message defined in the
                   blueye.protocol package or a well-known-type (FloatValue, Int32Value, etc) from
                   google.protobuf.wrappers_pb2

    Returns:
        A tuple with the message type and the deserialized message.
    """
    if msg.type_url.startswith("type.googleapis.com/google.protobuf"):
        payload_msg_name = msg.type_url.replace("type.googleapis.com/google.protobuf.", "")
        payload_type = wrappers.__getattribute__(payload_msg_name)
        payload_msg_deserialized = payload_type.FromString(msg.value)
        return (payload_type, payload_msg_deserialized)

    payload_msg_name = msg.type_url.replace("type.googleapis.com/blueye.protocol.", "")
    payload_type = bp.__getattribute__(payload_msg_name)
    payload_msg_deserialized = payload_type.deserialize(msg.value)
    return (payload_type, payload_msg_deserialized)

is_scalar_type 

is_scalar_type(msg: Message) -> bool

Check if a message is a scalar type

Parameters:

  • msg (Message) –

    The message to check

Returns:

  • bool –

    True if the message is a scalar type, False otherwise

Source code in blueye/sdk/utils.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
def is_scalar_type(msg: proto.message.Message) -> bool:
    """Check if a message is a scalar type

    Args:
        msg (proto.message.Message): The message to check

    Returns:
        True if the message is a scalar type, False otherwise
    """

    scalar_types = (
        FloatValue,
        Int32Value,
        Int64Value,
        UInt32Value,
        UInt64Value,
        DoubleValue,
        BoolValue,
        StringValue,
        BytesValue,
    )
    return isinstance(msg, scalar_types)

open_local_documentation 

open_local_documentation()

Open a pre-built local version of the SDK documentation

Useful when you are connected to the drone wifi, and don't have access to the online version.

Source code in blueye/sdk/utils.py 
65
66
67
68
69
70
71
72
73
74
75
def open_local_documentation():
    """Open a pre-built local version of the SDK documentation

    Useful when you are connected to the drone wifi, and don't have access to the online version.
    """
    sdk_path = os.path.dirname(blueye.sdk.__file__)

    # The documentation is located next to the top-level package so we move up a couple of levels
    documentation_path = os.path.abspath(sdk_path + "/../../blueye.sdk_docs/index.html")

    webbrowser.open(documentation_path)