Message Class

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.

AllLinkCleanupFailureReport

Public properties:

• address:
• group:

Public methods:

• from_raw_message:

AllLinkCleanupStatusReport

Public properties:

• acknak:
• isack:
• isnak:

Public methods:

• from_raw_message:

AllLinkComplete

Public properties:

• address:
• category:
• firmware:
• group:
• iscontroller:
• isdeleted:
• isresponder:
• linkcode:
• subcategory:

Public methods:

• from_raw_message:

AllLinkRecordResponse

Public properties: : address:

• controlFlags:
• group:
• isController:
• isRecordinuse:
• isSlave:
• linkdata1:
• linkdata2:
• linkdata3:

Public methods:

• from_raw_message:

ButtonEventReport

Public properties:

• event:
• eventText:

Public methods:

• from_raw_message:

CancelAllLinking

Public properties:

• acknak:
• isack:
• isnak:

Public methods:

• from_raw_message:

##ExtendedReceive Public properties:

• address:
• cmd1:
• cmd2:
• flags:
• target:
• targetHi:
• targetLow:
• targetMed:
• userdata:

Public methods:

• from_raw_message:
• template:

ExtendedSend

Public properties:

• acknak:
• address:
• cmd1:
• cmd2:
• flags:
• isack:
• isnak:
• userdata:

Public methods:

• from_raw_message:
• template:

GetFirstAllLinkRecord

Public properties:

• acknak:
• isack:
• isnak:

Public methods:

• from_raw_message:

GetIMInfo

Public properties:

• acknak:
• address:
• category:
• firmware:
• isack:
• isnak:
• subcategory:

Public methods:

• from_raw_message:

GetImConfiguration

Public properties:

• acknak:
• imConfigurationFlags:
• isack:
• isnak:

Public methods:

• from_raw_message:

GetNextAllLinkRecord

Public properties:

• acknak:
• isack:
• isnak:

Public methods:

• from_raw_message:

ResetIM

Public properties:

• acknak:
• isack:
• isnak:

Public methods:

• from_raw_message:

SendAlllinkCommand

Public properties:

• allLinkCommmand:
• broadcastCommand:
• group:
• isack:
• isnak:

Public methods:

• from_raw_message:

StandardReceive

Public properties:

• address:
• cmd1:
• cmd2:
• flags:
• target:
• targetHi:
• targetLow:
• targetMed:

Public methods:

• from_raw_message:
• template:

StandardSend

Public properties:

• acknak:
• address:
• cmd1:
• cmd2:
• flags:
• isack:
• isnak:

Public methods:

• from_raw_message:
• template:

StartAllLinking

Public properties:

• acknak:
• group:
• isack:
• isnak:
• linkCode:

Public methods:

• from_raw_message:

UserReset

Public properties:

• None Public methods:
• from_raw_message:

X10received

Public properties:

• command_msg:
• flag:
• rawX10:
• unit_code_msg:

Public methods:

• from_raw_message:

X10send

Public properties:

• acknak':
• command_msg:
• flag:
• isack:
• isnak:
• rawX10:
• unit_code_msg:

Public methods:

• from_raw_message: