PPNet.Message.Hello (pp_net v0.1.5)

Copy Markdown View Source

This module defines the PPNet.Message.Hello struct and provides functions to parse a binary or list representation of a Hello message into this struct.

Summary

Types

t()

The PPNet.Message.Hello struct

Functions

is_valid_types(unique_id, board_identifier, version, board_version, boot_id, ppnet_version)
is_valid_types_to_parse(unique_id, board_identifier, version, board_version, boot_id, ppnet_version, datetime_unix)

Types

t()

@type t() :: %PPNet.Message.Hello{
  board_identifier: String.t(),
  board_version: non_neg_integer(),
  boot_id: non_neg_integer(),
  datetime: DateTime.t(),
  ppnet_version: non_neg_integer(),
  unique_id: String.t(),
  version: non_neg_integer()
}

The PPNet.Message.Hello struct

Fields

  • unique_id - The unique ID of the device
  • board_identifier - The name of the board
  • version - The version of the software
  • board_version - The version of the board
  • boot_id - The boot ID of the board
  • ppnet_version - The version of the PPNet library
  • datetime - The timestamp when the hello message was sent

Functions

is_valid_types(unique_id, board_identifier, version, board_version, boot_id, ppnet_version)

(macro)

is_valid_types_to_parse(unique_id, board_identifier, version, board_version, boot_id, ppnet_version, datetime_unix)

(macro)