mirror of
https://github.com/meshtastic/python.git
synced 2026-09-21 11:15:43 -04:00
63 lines
2.6 KiB
Python
Generated
63 lines
2.6 KiB
Python
Generated
"""
|
|
@generated by mypy-protobuf. Do not edit manually!
|
|
isort:skip_file
|
|
"""
|
|
|
|
import builtins
|
|
import google.protobuf.descriptor
|
|
import google.protobuf.message
|
|
import meshtastic.protobuf.channel_pb2
|
|
import meshtastic.protobuf.config_pb2
|
|
import typing
|
|
|
|
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
|
|
|
|
@typing.final
|
|
class MeshBeacon(google.protobuf.message.Message):
|
|
"""
|
|
Payload for MESH_BEACON_APP packets.
|
|
Periodically broadcast by nodes in beacon mode.
|
|
Listeners deliver the text message to the local inbox and cache any offered
|
|
channel/preset for the client app to act on — the firmware never auto-applies them.
|
|
"""
|
|
|
|
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
|
|
MESSAGE_FIELD_NUMBER: builtins.int
|
|
OFFER_CHANNEL_FIELD_NUMBER: builtins.int
|
|
OFFER_REGION_FIELD_NUMBER: builtins.int
|
|
OFFER_PRESET_FIELD_NUMBER: builtins.int
|
|
message: builtins.str
|
|
"""
|
|
Human-readable beacon message. Max 100 bytes enforced by firmware on send.
|
|
"""
|
|
offer_region: meshtastic.protobuf.config_pb2.Config.LoRaConfig.RegionCode.ValueType
|
|
"""
|
|
Optional region being advertised alongside offer_preset.
|
|
"""
|
|
offer_preset: meshtastic.protobuf.config_pb2.Config.LoRaConfig.ModemPreset.ValueType
|
|
"""
|
|
Optional modem preset being advertised.
|
|
Combined with offer_region, tells a client "there is a mesh on this preset/region".
|
|
"""
|
|
@property
|
|
def offer_channel(self) -> meshtastic.protobuf.channel_pb2.ChannelSettings:
|
|
"""
|
|
Optional channel (name + PSK) being advertised to listening clients.
|
|
A client app may offer to switch the user to this channel; firmware never applies it automatically.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
*,
|
|
message: builtins.str = ...,
|
|
offer_channel: meshtastic.protobuf.channel_pb2.ChannelSettings | None = ...,
|
|
offer_region: meshtastic.protobuf.config_pb2.Config.LoRaConfig.RegionCode.ValueType = ...,
|
|
offer_preset: meshtastic.protobuf.config_pb2.Config.LoRaConfig.ModemPreset.ValueType | None = ...,
|
|
) -> None: ...
|
|
def HasField(self, field_name: typing.Literal["_offer_preset", b"_offer_preset", "offer_channel", b"offer_channel", "offer_preset", b"offer_preset"]) -> builtins.bool: ...
|
|
def ClearField(self, field_name: typing.Literal["_offer_preset", b"_offer_preset", "message", b"message", "offer_channel", b"offer_channel", "offer_preset", b"offer_preset", "offer_region", b"offer_region"]) -> None: ...
|
|
def WhichOneof(self, oneof_group: typing.Literal["_offer_preset", b"_offer_preset"]) -> typing.Literal["offer_preset"] | None: ...
|
|
|
|
global___MeshBeacon = MeshBeacon
|