Indigo iMessage Plugin

What it can do:

• Parse and send iMessages from within Indigo
• Send Animated GIFs/pdf files etc from within Indigo
• Works with Mojave, untested on below versions - but shouldn't be issue
• Indigo 7.1 and above
• Beta currently

For Mojave will need to change System Permissions to access imsg database file

Basics

• Mojave tested
• Indigo 7.2
• Need to be signed into Messages/iMsg on Indigo Mac with ideally separate indigo account
• Will very likely need to give Indigo and IndigoPluginHost.app and IndigoServer.app Full Disk Access in the Security and Privacy settings

(sorry - don't believe any way around this - and probably needed for other plugins)

See here:

https://www.macworld.com/article/3311982/macs/the-difference-between-accessibility-and-full-disk-access.html

Installation

• Download latest release and enable

• Go to plugin Config screen to set allowed Buddies...

• If hard to find out Buddy Handle (sometimes email, sometimes phone) enable Config checkbox 'Show Buddy Handle in Log'. Send indigo Mac and iMsg if all is functioning correctly, the Plugin will highlight for you the correct Buddy Handle to use in the Plugin Config and the send iMessage boxes as required.

• Any issues turn debug logging on and check 3 checkboxes - should supply useful information (including Buddy Handles as sometimes email sometimes phone numbers.)

Works

• Connects to iMessage chat.db via sql and parse messages received via regular simple, read-only SQL command
• At first run will backup the iMsg database to Users/Documents file - just in case... (haven't had any issues)
• Checks every few seconds - so far no problems in my testing
• Need to set allowed Buddies in Plugin Config otherwise any received iMsg will be ignored
• No Indigo devices needed - works solely through triggers and action

Setup Commands Recognised

• Enables you to recognise any iMsg received from Buddy as something to act on
• No formatting of message
• Just simple whole text

Felt best to use Indigo itself for actions with Triggers being the message itself - means very familiar

Create Separate Indigo Triggers for iMsg Plugin for each command want recognised

Via individual Trigger for each iMessage text wish to action on

eg. this an Indigo Trigger

Type of trigger is IMessage Plugin Event, Command Received

Edit the command Received, then standard indigo conditions and actions performed.

Then can create any indigo action passed on the command received, including a iMsg reply to confirm.

eg. One Indigo Action from same Trigger

Example Commands (any text you wish can be a trigger)

• All off
• Gate Open
• Lock House
• Alarm on

Three current Plugin Actions

Send Imsg

• Allow to send imsg text to any buddy you know
• Tick box - to send reply to last buddy received message from enabling ongoing conversation
• Allows variable and device state substitution
• So can send message:
• 'Glenn is located %%d:1490780461:address%% and has about %%d:1490780461:homeTimeText%% to travel to get home' & clever indigo will fill in the blanks

Send iMsgFile

• sends file/image/animated gif to buddy (again has tickbox for last buddy)
• Allows sending Animated Gifs via BlueIris or other Security plugin.
• Just need path to file location,or %%v:112312%% Variable substition and save to path
• eg. The BlueIris lastAnimGif path variable which is updated by BlueIris plugin when AnimatedGif created.

Ask iMsg Question

• Sends a question to Buddy - waits the timeout period for a positive or negative response

• If timeout sends a timeout reply

• If confirmation received - then runs the specified action group

• Following are valid confirmation replies - anything else will be ignored, OR if matches trigger acted on whilst waiting.

valid = {"yes": True, "y": True, "ye": True, 'yeah':True, 'ok':True, "no": False, "n": False, 'nope':False, 'never':False}

Sorry only english currently - but easy to add as many confirmation 'Oui' 'Non' that anyone needs down the track.

• Also allows - for specified reply (%%V:112123%%) substitution allowed

Additional

Messages accept indigo substitution for both variables and devices.

• So can send message: 'Glenn is located %%d:1490780461:address%% and has about %%d:1490780461:homeTimeText%% to travel to get home'

• with Number referring to FindFriends Device: Indigo will substitute both the address and the travel time in these places.

Python Script Control (if needed for full flexibility)

• Via a Python script you can access the Plugin actions to send and reply to Imsgs.
• So can via script create question and send via the following standard message.

    imessageID = 'com.GlennNZ.indigoplugin.iMessage'
    imsgPlugin = indigo.server.getPlugin(imessageID)
    imsgPlugin.executeAction('sendQuestion', props={'message':'The question you wish to ask', 'buddyId':'[email protected]', 'lastBuddy':False, 'timeout':600,'confirmedimsg':'All done.','actiongroup':ActionGroupIDtoRunwhenConfirmed})
    return;

Props to send:

• message: the question to ask
• buddyId: the buddy handle
• lastBuddy: just the last buddy msg received from
• timeout : timeout in seconds
• confirmedimsg: message if confirmation is received
• actiongroup: the ID number of the action group to run if confirmed.

Here is an example script that list devices on (via allowed list, and notallowed list), saves this list to a variable and then sends message listing devices on, via the plugin waits for confirmation, before running the confirmation AG to turn off all listed in variable.

on_name = []
on_id = []

def AskQuestionGlenn(question, AGtoRun, replyifsuccess) :
    
    imessageID = 'com.GlennNZ.indigoplugin.iMessage'
    imsgPlugin = indigo.server.getPlugin(imessageID)
    imsgPlugin.executeAction('sendQuestion', props={'message':question, 'buddyId':'[email protected]', 'lastBuddy':False, 'timeout':600,'confirmedimsg':replyifsuccess,'actiongroup':AGtoRun})
    return;

def CheckModulesRunning() :
    acceptable_modules = ["Smart Switch (DSC24)","RGBW LED Bulb (ZW098)","Smart Energy Switch (DSC24-2E)","Dimmer Switch (FGD211)","Smart Energy Illuminator (DSC08101)",                     "Relay Power Switch","Smart Energy Switch (DSC06106)", "Double Relay Switch (FGS221)", "Hue Bulb (Original, Downlight, Spotlight, LightStrip Plus)" ]

    notallowedid = [1049034630, 879903489, 1732408457, 1618015973,1595081762,660021281,1509636685,90390894,1047676499,614856779,1373207126,1332040796,1797065670]

    dev_list = indigo.devices.iter()
    for x in dev_list:
        if hasattr(x, "displayStateValRaw") and x.displayStateValRaw not in ["off", 0] and x.model in acceptable_modules and x.id not in notallowedid :
            on_name.append(x.name)
            on_id.append(x.id)
    return;

CheckModulesRunning();

numberon = len(on_id)

if numberon == 0 :
    indigo.server.log("Checking Running devices - None found on.")

if numberon > 0 :
    indigo.server.log("Checking Running devices - Modules running - iMsg sent")
    Question = "Attention\n I have noticed that you are both away and \nThe following lights/devices are on \n"
    ListModules = " , ".join(on_name)
    idsoff = indigo.variables[1410863016] # "MsgOnDevices"
    indigo.variable.updateValue(idsoff, unicode(on_id))
    Statement = Question + ListModules + "\n Would you like me to turn them off?"
    AskQuestionGlenn(Statement, 95680424, "They have all been turned off");
    

and for completeness here is the Action Group that is called when above is run

onid = indigo.variables[1410863016] # "MsgOnDevices"

onidstring = onid.value
onidstring = onidstring.replace("[","")
onidstring = onidstring.replace("]","")  # Covert indigo string variable back to list
onidstring = onidstring.replace(" ","")

if len(onidstring) > 1:
    onidlist = onidstring.split(",")
else:
    onidlist = onidstring


if len(onidlist) >= 1 :
    indigo.server.log("iMsg: Turning off All Devices ")
    indigo.server.log(unicode(onidstring))
    for i in range(len(onidlist)):
	    indigo.device.turnOff(int(onidlist[i]))
elif len(onidlist) < 1 :
    indigo.server.log("iMsg: No Devices On ")