Generated

from message meshtastic.UserLite

Hierarchy

Constructors

  • Parameters

    Returns UserLite

Properties

hwModel: HardwareModel

TBEAM, HELTEC, etc... Starting in 1.2.11 moved to hw_model enum in the NodeInfo object. Apps will still need the string here for older builds (so OTA update can find the right image), but if the enum is available it will be used instead.

Generated

from field: meshtastic.HardwareModel hw_model = 4;

isLicensed: boolean

In some regions Ham radio operators have different bandwidth limitations than others. If this user is a licensed operator, set this flag. Also, "long_name" should be their licence number.

Generated

from field: bool is_licensed = 5;

longName: string

A full name for this user, i.e. "Kevin Hester"

Generated

from field: string long_name = 2;

macaddr: Uint8Array

This is the addr of the radio.

Generated

from field: bytes macaddr = 1 [deprecated = true];

Deprecated

publicKey: Uint8Array

The public key of the user's device. This is sent out to other nodes on the mesh to allow them to compute a shared secret key.

Generated

from field: bytes public_key = 7;

Indicates that the user's role in the mesh

Generated

from field: meshtastic.Config.DeviceConfig.Role role = 6;

shortName: string

A VERY short name, ideally two characters. Suitable for a tiny OLED screen

Generated

from field: string short_name = 3;

fields: FieldList
runtime: ProtoRuntime
typeName: "meshtastic.UserLite" = "meshtastic.UserLite"

Methods

  • Create a deep copy.

    Returns UserLite

  • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<UserLite>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

  • Parameters

    Returns boolean

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns UserLite

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns UserLite

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns UserLite

Generated using TypeDoc