meshastic.web/packages/core/src/meshDevice.ts

import { create, fromBinary, toBinary } from "@bufbuild/protobuf";
import * as Protobuf from "@meshtastic/protobufs";
import { Logger } from "tslog";

import { Constants } from "./constants.ts";
import type { Destination, PacketMetadata, Transport } from "./types.ts";
import { ChannelNumber, DeviceStatusEnum, Emitter } from "./types.ts";
import { EventSystem, Queue, Xmodem } from "./utils/mod.ts";
import { decodePacket } from "./utils/transform/decodePacket.ts";

export class MeshDevice {
  public transport: Transport;

  /** Logs to the console and the logging event emitter */
  public log: Logger<unknown>;

  /** Describes the current state of the device */
  protected deviceStatus: DeviceStatusEnum;

  /** Describes the current state of the device */
  protected isConfigured: boolean;

  /** Are there any settings that have yet to be applied? */
  protected pendingSettingsChanges: boolean;

  /** Device's node number */
  private myNodeInfo: Protobuf.Mesh.MyNodeInfo;

  /** Randomly generated number to ensure confiuration lockstep */
  public configId: number;

  /**
   * Packert queue, to space out transmissions and routing handle errors and
   * acks
   */
  public queue: Queue;

  public events: EventSystem;

  public xModem: Xmodem;

  private _heartbeatIntervalId: ReturnType<typeof setInterval> | undefined;

  constructor(transport: Transport, configId?: number) {
    this.log = new Logger({
      name: "iMeshDevice",
      prettyLogTemplate:
        "{{hh}}:{{MM}}:{{ss}}:{{ms}}\t{{logLevelName}}\t[{{name}}]\t",
    });

    this.transport = transport;
    this.deviceStatus = DeviceStatusEnum.DeviceDisconnected;
    this.isConfigured = false;
    this.pendingSettingsChanges = false;
    this.myNodeInfo = create(Protobuf.Mesh.MyNodeInfoSchema);
    this.configId = configId ?? this.generateRandId();
    this.queue = new Queue();
    this.events = new EventSystem();
    this.xModem = new Xmodem(this.sendRaw.bind(this)); //TODO: try wihtout bind

    this.events.onDeviceStatus.subscribe((status) => {
      this.deviceStatus = status;
      if (status === DeviceStatusEnum.DeviceConfigured) {
        this.isConfigured = true;
      } else if (status === DeviceStatusEnum.DeviceConfiguring) {
        this.isConfigured = false;
      }
    });

    this.events.onMyNodeInfo.subscribe((myNodeInfo) => {
      this.myNodeInfo = myNodeInfo;
    });

    this.events.onPendingSettingsChange.subscribe((state) => {
      this.pendingSettingsChanges = state;
    });

    this.transport.fromDevice.pipeTo(decodePacket(this));
  }

  /** Abstract method that connects to the radio */
  // protected abstract connect(
  //   parameters: Types.ConnectionParameters,
  // ): Promise<void>;

  /** Abstract method that disconnects from the radio */
  // protected abstract disconnect(): void;

  /** Abstract method that pings the radio */
  // protected abstract ping(): Promise<boolean>;

  /**
   * Sends a text over the radio
   */
  public async sendText(
    text: string,
    destination?: Destination,
    wantAck?: boolean,
    channel?: ChannelNumber,
    replyId?: number,
    emoji?: number,
  ): Promise<number> {
    this.log.debug(
      Emitter[Emitter.SendText],
      `📤 Sending message to ${destination ?? "broadcast"} on channel ${
        channel?.toString() ?? 0
      }`,
    );

    const enc = new TextEncoder();

    return await this.sendPacket(
      enc.encode(text),
      Protobuf.Portnums.PortNum.TEXT_MESSAGE_APP,
      destination ?? "broadcast",
      channel,
      wantAck,
      false,
      true,
      replyId,
      emoji,
    );
  }

  /**
   * Sends a text over the radio
   */
  public sendWaypoint(
    waypointMessage: Protobuf.Mesh.Waypoint,
    destination: Destination,
    channel?: ChannelNumber,
  ): Promise<number> {
    this.log.debug(
      Emitter[Emitter.SendWaypoint],
      `📤 Sending waypoint to ${destination} on channel ${
        channel?.toString() ?? 0
      }`,
    );

    waypointMessage.id = this.generateRandId();

    return this.sendPacket(
      toBinary(Protobuf.Mesh.WaypointSchema, waypointMessage),
      Protobuf.Portnums.PortNum.WAYPOINT_APP,
      destination,
      channel,
      true,
      false,
    );
  }

  /**
   * Sends packet over the radio
   */
  public async sendPacket(
    byteData: Uint8Array,
    portNum: Protobuf.Portnums.PortNum,
    destination: Destination,
    channel: ChannelNumber = ChannelNumber.Primary,
    wantAck = true,
    wantResponse = true,
    echoResponse = false,
    replyId?: number,
    emoji?: number,
  ): Promise<number> {
    this.log.trace(
      Emitter[Emitter.SendPacket],
      `📤 Sending ${Protobuf.Portnums.PortNum[portNum]} to ${destination}`,
    );

    const meshPacket = create(Protobuf.Mesh.MeshPacketSchema, {
      payloadVariant: {
        case: "decoded",
        value: {
          payload: byteData,
          portnum: portNum,
          wantResponse,
          emoji,
          replyId,
          dest: 0, //change this!
          requestId: 0, //change this!
          source: 0, //change this!
        },
      },
      from: this.myNodeInfo.myNodeNum,
      to:
        destination === "broadcast"
          ? Constants.broadcastNum
          : destination === "self"
            ? this.myNodeInfo.myNodeNum
            : destination,
      id: this.generateRandId(),
      wantAck: wantAck,
      channel,
    });

    const toRadioMessage = create(Protobuf.Mesh.ToRadioSchema, {
      payloadVariant: {
        case: "packet",
        value: meshPacket,
      },
    });

    if (echoResponse) {
      meshPacket.rxTime = Math.trunc(Date.now() / 1000);
      this.handleMeshPacket(meshPacket);
    }
    return await this.sendRaw(
      toBinary(Protobuf.Mesh.ToRadioSchema, toRadioMessage),
      meshPacket.id,
    );
  }

  /**
   * Sends raw packet over the radio
   */
  public async sendRaw(
    toRadio: Uint8Array,
    id: number = this.generateRandId(),
  ): Promise<number> {
    if (toRadio.length > 512) {
      throw new Error("Message longer than 512 bytes, it will not be sent!");
    }
    this.queue.push({
      id,
      data: toRadio,
    });

    await this.queue.processQueue(this.transport.toDevice);

    return this.queue.wait(id);
  }

  /**
   * Writes config to device
   */
  public async setConfig(config: Protobuf.Config.Config): Promise<number> {
    this.log.debug(
      Emitter[Emitter.SetConfig],
      `⚙️ Setting config, Variant: ${config.payloadVariant.case ?? "Unknown"}`,
    );

    if (!this.pendingSettingsChanges) {
      await this.beginEditSettings();
    }

    const configMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "setConfig",
        value: config,
      },
    });

    return this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, configMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Writes module config to device
   */
  public async setModuleConfig(
    moduleConfig: Protobuf.ModuleConfig.ModuleConfig,
  ): Promise<number> {
    this.log.debug(Emitter[Emitter.SetModuleConfig], "⚙️ Setting module config");

    const moduleConfigMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "setModuleConfig",
        value: moduleConfig,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, moduleConfigMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  // Write cannedMessages to device
  public async setCannedMessages(
    cannedMessages: Protobuf.CannedMessages.CannedMessageModuleConfig,
  ): Promise<number> {
    this.log.debug(
      Emitter[Emitter.SetCannedMessages],
      "⚙️ Setting CannedMessages",
    );

    const cannedMessagesMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "setCannedMessageModuleMessages",
        value: cannedMessages.messages,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, cannedMessagesMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Sets devices owner data
   */
  public async setOwner(owner: Protobuf.Mesh.User): Promise<number> {
    this.log.debug(Emitter[Emitter.SetOwner], "👤 Setting owner");

    const setOwnerMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "setOwner",
        value: owner,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, setOwnerMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Sets devices ChannelSettings
   */
  public async setChannel(channel: Protobuf.Channel.Channel): Promise<number> {
    this.log.debug(
      Emitter[Emitter.SetChannel],
      `📻 Setting Channel: ${channel.index}`,
    );

    const setChannelMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "setChannel",
        value: channel,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, setChannelMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Triggers Device to enter DFU mode
   */
  public async enterDfuMode(): Promise<number> {
    this.log.debug(Emitter[Emitter.EnterDfuMode], "🔌 Entering DFU mode");

    const enterDfuModeRequest = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "enterDfuModeRequest",
        value: true,
      },
    });
    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, enterDfuModeRequest),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Sets static position of device
   */
  public async setPosition(
    positionMessage: Protobuf.Mesh.Position,
  ): Promise<number> {
    return await this.sendPacket(
      toBinary(Protobuf.Mesh.PositionSchema, positionMessage),
      Protobuf.Portnums.PortNum.POSITION_APP,
      "self",
    );
  }

  /**
   * Sets the fixed position of a device. Can be used to
   * position GPS-less devices.
   */
  public async setFixedPosition(
    latitude: number,
    longitude: number,
  ): Promise<number> {
    const setPositionMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "setFixedPosition",
        value: create(Protobuf.Mesh.PositionSchema, {
          latitudeI: Math.floor(latitude / 1e-7),
          longitudeI: Math.floor(longitude / 1e-7),
        }),
      },
    });
    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, setPositionMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
      0,
      true,
      false,
    );
  }

  /**
   * Remove the fixed position of a device
   */
  public async removeFixedPosition(): Promise<number> {
    const removePositionMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "removeFixedPosition",
        value: true,
      },
    });
    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, removePositionMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
      0,
      true,
      false,
    );
  }

  /**
   * Gets specified channel information from the radio
   */
  public async getChannel(index: number): Promise<number> {
    this.log.debug(
      Emitter[Emitter.GetChannel],
      `📻 Requesting Channel: ${index}`,
    );

    const getChannelRequestMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "getChannelRequest",
        value: index + 1,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, getChannelRequestMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Gets devices config
   */
  public async getConfig(
    configType: Protobuf.Admin.AdminMessage_ConfigType,
  ): Promise<number> {
    this.log.debug(Emitter[Emitter.GetConfig], "⚙️ Requesting config");

    const getRadioRequestMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "getConfigRequest",
        value: configType,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, getRadioRequestMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Gets Module config
   */
  public async getModuleConfig(
    moduleConfigType: Protobuf.Admin.AdminMessage_ModuleConfigType,
  ): Promise<number> {
    this.log.debug(
      Emitter[Emitter.GetModuleConfig],
      "⚙️ Requesting module config",
    );

    const getRadioRequestMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "getModuleConfigRequest",
        value: moduleConfigType,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, getRadioRequestMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /** Gets devices Owner */
  public async getOwner(): Promise<number> {
    this.log.debug(Emitter[Emitter.GetOwner], "👤 Requesting owner");

    const getOwnerRequestMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "getOwnerRequest",
        value: true,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, getOwnerRequestMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Gets devices metadata
   */
  public async getMetadata(nodeNum: number): Promise<number> {
    this.log.debug(
      Emitter[Emitter.GetMetadata],
      `🏷️ Requesting metadata from ${nodeNum}`,
    );

    const getDeviceMetricsRequestMessage = create(
      Protobuf.Admin.AdminMessageSchema,
      {
        payloadVariant: {
          case: "getDeviceMetadataRequest",
          value: true,
        },
      },
    );

    return await this.sendPacket(
      toBinary(
        Protobuf.Admin.AdminMessageSchema,
        getDeviceMetricsRequestMessage,
      ),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      nodeNum,
      ChannelNumber.Admin,
    );
  }

  /**
   * Clears specific channel with the designated index
   */
  public async clearChannel(index: number): Promise<number> {
    this.log.debug(
      Emitter[Emitter.ClearChannel],
      `📻 Clearing Channel ${index}`,
    );

    const channel = create(Protobuf.Channel.ChannelSchema, {
      index,
      role: Protobuf.Channel.Channel_Role.DISABLED,
    });
    const setChannelMessage = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "setChannel",
        value: channel,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, setChannelMessage),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  private async beginEditSettings(): Promise<number> {
    this.events.onPendingSettingsChange.dispatch(true);

    const beginEditSettings = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "beginEditSettings",
        value: true,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, beginEditSettings),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  public async commitEditSettings(): Promise<number> {
    this.events.onPendingSettingsChange.dispatch(false);

    const commitEditSettings = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "commitEditSettings",
        value: true,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, commitEditSettings),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Resets the internal NodeDB of the radio, usefull for removing old nodes
   * that no longer exist.
   */
  public async resetNodes(): Promise<number> {
    this.log.debug(Emitter[Emitter.ResetNodes], "📻 Resetting NodeDB");

    const resetNodes = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "nodedbReset",
        value: 1,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, resetNodes),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Removes a node from the internal NodeDB of the radio by node number
   */
  public async removeNodeByNum(nodeNum: number): Promise<number> {
    this.log.debug(
      Emitter[Emitter.RemoveNodeByNum],
      `📻 Removing Node ${nodeNum} from NodeDB`,
    );

    const removeNodeByNum = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "removeByNodenum",
        value: nodeNum,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, removeNodeByNum),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /** Shuts down the current node after the specified amount of time has elapsed. */
  public async shutdown(time: number): Promise<number> {
    this.log.debug(
      Emitter[Emitter.Shutdown],
      `🔌 Shutting down ${time > 2 ? "now" : `in ${time} seconds`}`,
    );

    const shutdown = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "shutdownSeconds",
        value: time,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, shutdown),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /** Reboots the current node after the specified amount of time has elapsed. */
  public async reboot(time: number): Promise<number> {
    this.log.debug(
      Emitter[Emitter.Reboot],
      `🔌 Rebooting node ${time === 0 ? "now" : `in ${time} seconds`}`,
    );

    const reboot = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "rebootSeconds",
        value: time,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, reboot),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Reboots the current node into OTA mode after the specified amount of time has elapsed.
   */
  public async rebootOta(time: number): Promise<number> {
    this.log.debug(
      Emitter[Emitter.RebootOta],
      `🔌 Rebooting into OTA mode ${time === 0 ? "now" : `in ${time} seconds`}`,
    );

    const rebootOta = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "rebootOtaSeconds",
        value: time,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, rebootOta),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Factory resets the current device
   */
  public async factoryResetDevice(): Promise<number> {
    this.log.debug(Emitter[Emitter.FactoryReset], "♻️ Factory resetting device");

    const factoryReset = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "factoryResetDevice",
        value: 1,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, factoryReset),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Factory resets the current config
   */
  public async factoryResetConfig(): Promise<number> {
    this.log.debug(Emitter[Emitter.FactoryReset], "♻️ Factory resetting config");

    const factoryReset = create(Protobuf.Admin.AdminMessageSchema, {
      payloadVariant: {
        case: "factoryResetConfig",
        value: 1,
      },
    });

    return await this.sendPacket(
      toBinary(Protobuf.Admin.AdminMessageSchema, factoryReset),
      Protobuf.Portnums.PortNum.ADMIN_APP,
      "self",
    );
  }

  /**
   * Triggers the device configure process
   */
  public configure(): Promise<number> {
    this.log.debug(
      Emitter[Emitter.Configure],
      "⚙️ Requesting device configuration",
    );
    this.updateDeviceStatus(DeviceStatusEnum.DeviceConfiguring);

    const toRadio = create(Protobuf.Mesh.ToRadioSchema, {
      payloadVariant: {
        case: "wantConfigId",
        value: this.configId,
      },
    });

    return this.sendRaw(toBinary(Protobuf.Mesh.ToRadioSchema, toRadio));
  }

  /**
   * Serial connection requires a heartbeat ping to stay connected, otherwise times out after 15 minutes
   */
  public heartbeat(): Promise<number> {
    this.log.debug(Emitter[Emitter.Ping], "❤️ Send heartbeat ping to radio");

    const toRadio = create(Protobuf.Mesh.ToRadioSchema, {
      payloadVariant: {
        case: "heartbeat",
        value: {},
      },
    });

    return this.sendRaw(toBinary(Protobuf.Mesh.ToRadioSchema, toRadio));
  }

  /**
   * Initializes the heartbeat interval, which sends a heartbeat ping every interval milliseconds.
   */
  public setHeartbeatInterval(interval: number): void {
    if (this._heartbeatIntervalId !== undefined) {
      clearInterval(this._heartbeatIntervalId);
    }
    this._heartbeatIntervalId = setInterval(() => {
      this.heartbeat();
    }, interval);
  }

  /**
   * Sends a trace route packet to the designated node
   */
  public async traceRoute(destination: number): Promise<number> {
    const routeDiscovery = create(Protobuf.Mesh.RouteDiscoverySchema, {
      route: [],
    });

    return await this.sendPacket(
      toBinary(Protobuf.Mesh.RouteDiscoverySchema, routeDiscovery),
      Protobuf.Portnums.PortNum.TRACEROUTE_APP,
      destination,
    );
  }

  /**
   * Requests position from the designated node
   */
  public async requestPosition(destination: number): Promise<number> {
    return await this.sendPacket(
      new Uint8Array(),
      Protobuf.Portnums.PortNum.POSITION_APP,
      destination,
    );
  }

  /**
   * Updates the device status eliminating duplicate status events
   */
  public updateDeviceStatus(status: DeviceStatusEnum): void {
    if (status !== this.deviceStatus) {
      this.events.onDeviceStatus.dispatch(status);
    }
  }

  /**
   * Generates random packet identifier
   *
   * @returns {number} Random packet ID
   */
  private generateRandId(): number {
    const seed = crypto.getRandomValues(new Uint32Array(1));
    if (!seed[0]) {
      throw new Error("Cannot generate CSPRN");
    }

    return Math.floor(seed[0] * 2 ** -32 * 1e9);
  }

  /** Completes all Events */
  public complete(): void {
    this.queue.clear();
  }

  /**  Disconnects from the device **/
  public async disconnect(): Promise<void> {
    this.log.debug(Emitter[Emitter.Disconnect], "🔌 Disconnecting from device");

    if (this._heartbeatIntervalId !== undefined) {
      clearInterval(this._heartbeatIntervalId);
    }

    this.complete();
    await this.transport.toDevice.close();
    await this.transport.disconnect();
  }

  /**
   * Gets called when a MeshPacket is received from device
   */
  public handleMeshPacket(meshPacket: Protobuf.Mesh.MeshPacket): void {
    this.events.onMeshPacket.dispatch(meshPacket);
    if (meshPacket.from !== this.myNodeInfo.myNodeNum) {
      /**
       * TODO: this shouldn't be called unless the device interracts with the
       * mesh, currently it does.
       */
      this.events.onMeshHeartbeat.dispatch(new Date());
    }

    switch (meshPacket.payloadVariant.case) {
      case "decoded": {
        this.handleDecodedPacket(meshPacket.payloadVariant.value, meshPacket);
        break;
      }

      case "encrypted": {
        this.log.debug(
          Emitter[Emitter.HandleMeshPacket],
          "🔐 Device received encrypted data packet, ignoring.",
        );
        break;
      }

      default:
        throw new Error(`Unhandled case ${meshPacket.payloadVariant.case}`);
    }
  }

  private handleDecodedPacket(
    dataPacket: Protobuf.Mesh.Data,
    meshPacket: Protobuf.Mesh.MeshPacket,
  ) {
    let adminMessage: Protobuf.Admin.AdminMessage | undefined;
    let routingPacket: Protobuf.Mesh.Routing | undefined;

    const packetMetadata: Omit<PacketMetadata<unknown>, "data"> = {
      id: meshPacket.id,
      rxTime: new Date(meshPacket.rxTime * 1000),
      type: meshPacket.to === Constants.broadcastNum ? "broadcast" : "direct",
      from: meshPacket.from,
      to: meshPacket.to,
      channel: meshPacket.channel,
    };

    this.log.trace(
      Emitter[Emitter.HandleMeshPacket],
      `📦 Received ${Protobuf.Portnums.PortNum[dataPacket.portnum]} packet`,
    );

    switch (dataPacket.portnum) {
      case Protobuf.Portnums.PortNum.TEXT_MESSAGE_APP: {
        this.events.onMessagePacket.dispatch({
          ...packetMetadata,
          data: new TextDecoder().decode(dataPacket.payload),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.REMOTE_HARDWARE_APP: {
        this.events.onRemoteHardwarePacket.dispatch({
          ...packetMetadata,
          data: fromBinary(
            Protobuf.RemoteHardware.HardwareMessageSchema,
            dataPacket.payload,
          ),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.POSITION_APP: {
        this.events.onPositionPacket.dispatch({
          ...packetMetadata,
          data: fromBinary(Protobuf.Mesh.PositionSchema, dataPacket.payload),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.NODEINFO_APP: {
        this.events.onUserPacket.dispatch({
          ...packetMetadata,
          data: fromBinary(Protobuf.Mesh.UserSchema, dataPacket.payload),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.ROUTING_APP: {
        routingPacket = fromBinary(
          Protobuf.Mesh.RoutingSchema,
          dataPacket.payload,
        );

        this.events.onRoutingPacket.dispatch({
          ...packetMetadata,
          data: routingPacket,
        });
        switch (routingPacket.variant.case) {
          case "errorReason": {
            if (
              routingPacket.variant.value === Protobuf.Mesh.Routing_Error.NONE
            ) {
              this.queue.processAck(dataPacket.requestId);
            } else {
              this.queue.processError({
                id: dataPacket.requestId,
                error: routingPacket.variant.value,
              });
            }

            break;
          }
          case "routeReply": {
            break;
          }
          case "routeRequest": {
            break;
          }

          default: {
            throw new Error(`Unhandled case ${routingPacket.variant.case}`);
          }
        }
        break;
      }

      case Protobuf.Portnums.PortNum.ADMIN_APP: {
        adminMessage = fromBinary(
          Protobuf.Admin.AdminMessageSchema,
          dataPacket.payload,
        );
        switch (adminMessage.payloadVariant.case) {
          case "getChannelResponse": {
            this.events.onChannelPacket.dispatch(
              adminMessage.payloadVariant.value,
            );
            break;
          }
          case "getOwnerResponse": {
            this.events.onUserPacket.dispatch({
              ...packetMetadata,
              data: adminMessage.payloadVariant.value,
            });
            break;
          }
          case "getConfigResponse": {
            this.events.onConfigPacket.dispatch(
              adminMessage.payloadVariant.value,
            );
            break;
          }
          case "getModuleConfigResponse": {
            this.events.onModuleConfigPacket.dispatch(
              adminMessage.payloadVariant.value,
            );
            break;
          }
          case "getDeviceMetadataResponse": {
            this.log.debug(
              Emitter[Emitter.GetMetadata],
              `🏷️ Received metadata packet from ${dataPacket.source}`,
            );

            this.events.onDeviceMetadataPacket.dispatch({
              ...packetMetadata,
              data: adminMessage.payloadVariant.value,
            });
            break;
          }
          case "getCannedMessageModuleMessagesResponse": {
            this.log.debug(
              Emitter[Emitter.GetMetadata],
              `🥫 Received CannedMessage Module Messages response packet`,
            );

            this.events.onCannedMessageModulePacket.dispatch({
              ...packetMetadata,
              data: adminMessage.payloadVariant.value,
            });
            break;
          }
          default: {
            this.log.error(
              Emitter[Emitter.HandleMeshPacket],
              `⚠️ Received unhandled AdminMessage, type ${
                adminMessage.payloadVariant.case ?? "undefined"
              }`,
              dataPacket.payload,
            );
          }
        }
        break;
      }

      case Protobuf.Portnums.PortNum.WAYPOINT_APP: {
        this.events.onWaypointPacket.dispatch({
          ...packetMetadata,
          data: fromBinary(Protobuf.Mesh.WaypointSchema, dataPacket.payload),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.AUDIO_APP: {
        this.events.onAudioPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.DETECTION_SENSOR_APP: {
        this.events.onDetectionSensorPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.REPLY_APP: {
        this.events.onPingPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload, //TODO: decode
        });
        break;
      }

      case Protobuf.Portnums.PortNum.IP_TUNNEL_APP: {
        this.events.onIpTunnelPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.PAXCOUNTER_APP: {
        this.events.onPaxcounterPacket.dispatch({
          ...packetMetadata,
          data: fromBinary(
            Protobuf.PaxCount.PaxcountSchema,
            dataPacket.payload,
          ),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.SERIAL_APP: {
        this.events.onSerialPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.STORE_FORWARD_APP: {
        this.events.onStoreForwardPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.RANGE_TEST_APP: {
        this.events.onRangeTestPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.TELEMETRY_APP: {
        this.events.onTelemetryPacket.dispatch({
          ...packetMetadata,
          data: fromBinary(
            Protobuf.Telemetry.TelemetrySchema,
            dataPacket.payload,
          ),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.ZPS_APP: {
        this.events.onZpsPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.SIMULATOR_APP: {
        this.events.onSimulatorPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.TRACEROUTE_APP: {
        this.events.onTraceRoutePacket.dispatch({
          ...packetMetadata,
          data: fromBinary(
            Protobuf.Mesh.RouteDiscoverySchema,
            dataPacket.payload,
          ),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.NEIGHBORINFO_APP: {
        this.events.onNeighborInfoPacket.dispatch({
          ...packetMetadata,
          data: fromBinary(
            Protobuf.Mesh.NeighborInfoSchema,
            dataPacket.payload,
          ),
        });
        break;
      }

      case Protobuf.Portnums.PortNum.ATAK_PLUGIN: {
        this.events.onAtakPluginPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.MAP_REPORT_APP: {
        this.events.onMapReportPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.PRIVATE_APP: {
        this.events.onPrivatePacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      case Protobuf.Portnums.PortNum.ATAK_FORWARDER: {
        this.events.onAtakForwarderPacket.dispatch({
          ...packetMetadata,
          data: dataPacket.payload,
        });
        break;
      }

      default:
        throw new Error(`Unhandled case ${dataPacket.portnum}`);
    }
  }
}