Skip to content

Message Class

Tom Harris edited this page Jun 12, 2018 · 6 revisions

The Message class is the abstract base class for all Insteon message types. The following message types are supported:

  • AllLinkCleanupFailureReport
  • AllLinkCleanupStatusReport
  • AllLinkComplete
  • AllLinkRecordResponse
  • ButtonEventReport
  • CancelAllLinking
  • ExtendedReceive
  • ExtendedSend
  • GetFirstAllLinkRecord
  • GetIMInfo
  • GetImConfiguration
  • GetNextAllLinkRecord
  • ResetIM
  • SendAlllinkCommand
  • StandardReceive
  • StandardSend
  • StartAllLinking
  • UserReset
  • X10received
  • X10send

The Message class has the following public properties:

  • bytes: Returns the message as a byte string.
  • code: Returns the message hex code (i.e. 0x50)
  • description: Returns a text description of the message type.
  • hex: Returns a text string representation of the hexidecimal characters of the byte string.
  • receivedSize: The required number of bytes in the message when it is received by the IM.
  • sendSize: The expected number of bytes in the message when it is sent by the IM.

The Message class has the following public methods:

  • matches_pattern: Tests to determine if the current message matches a pattern of another message. This is primarily used internally by the module to define message handling and message callbacks. See the MessageCallbacks class for more information. The matches_pattern class takes the following parameters:
    • other: The message to compare the current message to for pattern matching.

Startup Process

IM Class

  • PLM Class

  • Hub Class

Clone this wiki locally