# AppleScript Dictionary

To do: reformat into something readable. pare down to most-used terms.
Automation: Home automation for the rest of us Class action: An action taken by the Mac or by a controller as part of a responder or scheduled event. Plural form: actions Properties: <Inheritance> item [r/o] -- All of the properties of the superclass. parameters record -- parameters can include any other information required by a custom action amount integer -- amount to change or set; e.g., brightness level, temperature broadcast Unicode text -- Will this be sent to all devices? actionCode integer -- code specifying exactly what will be done; e.g., turn on, off, etc. Class announcement: announces a phrase Plural form: announcement Properties: <Inheritance> macAction [r/o] -- All of the properties of the superclass. textToSay Unicode text -- text to announce Class application: The home automation application of choice. Plural form: applications Elements: port by name, by numeric index, before/after another element, as a range of elements, satisfying a test device by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID scheduleSet by name, by numeric index, before/after another element, as a range of elements, satisfying a test controller by name, by numeric index, before/after another element, as a range of elements, satisfying a test window by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID document by name, by numeric index, before/after another element, as a range of elements, satisfying a test Properties: <Inheritance> application [r/o] -- All of the properties of the superclass. gadget guide gadget guide [r/o] -- The guide of available gadgets. controllerRecords list [r/o] -- internal data deviceRecords list [r/o] -- internal data catalogDictionary record [r/o] -- internal data Class controller: Hardware connected to the Mac via USB or serial that controls devices remotely Plural form: controllers Properties: <Inheritance> item [r/o] -- All of the properties of the superclass. asDictionary record -- internal data model model [r/o] -- Model of hardware that controls remote devices house code Unicode text -- The X-10 house code, such as "A" address Unicode text -- The address identifying this controller, such as "12.34.56" or house code "A" port port -- The USB or serial port where a controller may be attached to the Mac notes Unicode text [r/o] -- Your own notes about this particular installed controller name Unicode text [r/o] -- The unique name of the controller, such as "PowerLinc V2" Class controllerModel: Model of hardware that connects to the Mac to control devices remotely Plural form: controllerModels Properties: <Inheritance> model [r/o] -- All of the properties of the superclass. asDictionary record [r/o] -- internal data manufacturer Unicode text [r/o] -- The company that makes this model of hardware Class device: Hardware that can be controlled remotely, such as a lamp or appliance. Plural form: devices Properties: <Inheritance> item [r/o] -- All of the properties of the superclass. alias Unicode text -- X-10 alternative address for an INSTEON device asDictionary record -- internal data logging boolean -- whether the activity for this device is being logged model model [r/o] -- Model of hardware that can be controlled remotely, such as a lamp or appliance address Unicode text -- The unique address for communicating with this device, such as "A 5" or "12.34.56" notes Unicode text -- Your own notes describing this particular device name Unicode text -- The unique name identifying this particular device, such as "My LampLinc" status Unicode text -- current status of the device, if known; e.g., On, Off, other values as appropriate Class deviceAction: This operates a device remotely. Plural form: deviceActions Properties: <Inheritance> action [r/o] -- All of the properties of the superclass. device device -- This is the name of the remotely controlled device Class deviceModel: Model of hardware that can be controlled remotely, such as a lamp or appliance Plural form: deviceModels Properties: <Inheritance> model [r/o] -- All of the properties of the superclass. asDictionary record -- internal data Class event: Performs actions at a scheduled time Plural form: events Elements: action by numeric index, before/after another element, as a range of elements, satisfying a test Properties: <Inheritance> 'SItm' [r/o] -- All of the properties of the superclass. id Unicode text [r/o] -- string uniquely identifying this event security boolean -- Whether the actual time is varied for security, to make a home appear lived-in. days Unicode text -- string indicating which days of the week to schedule thie event; e.g. "-MTWTF-" sunset relative boolean -- Is the event based on the time of sunset? notes Unicode text -- Your own notes describing this particular event minute integer -- the minute of the time that the event is scheduled hour integer -- the hour of the time that the event is scheduled name Unicode text -- The name identifying this particular event, such as "Welcome Home" sunrise relative boolean -- Is the event based on the time of sunrise? Class gadget guide: This is the catalog of models of hardware. Elements: controllerModel by name, by numeric index, before/after another element, as a range of elements, satisfying a test deviceModel by name, by numeric index, before/after another element, as a range of elements, satisfying a test Properties: <Inheritance> item [r/o] -- All of the properties of the superclass. asDictionary record -- internal data Class imAction: Sends an instant message Plural form: imActions Properties: <Inheritance> macAction [r/o] -- All of the properties of the superclass. recipient Unicode text -- screen name of buddy to receive the message body Unicode text -- text of the message to send Class itemLocation: file path or web address of the item to open Plural form: itemLocations Class logAction: appends text to the log Plural form: logActions Properties: <Inheritance> macAction [r/o] -- All of the properties of the superclass. textToLog Unicode text -- text to be appended to the log Class macAction: kind of action taken by the Mac, like LogAction, ScriptAction, etc. Plural form: macActions Properties: <Inheritance> action [r/o] -- All of the properties of the superclass. Class mailAction: Sends an email message Plural form: mailActions Properties: < macAction [r/o] -- All of the properties of the superclass. from address anything -- email address you are sending from body Unicode text -- text of the message to send recipient list -- email addresses to receive the message blind copy addresses anything -- email addresses to blind copy when sending the message copy addresses list -- email addresses to copy when sending the message subject anything -- subject line of the message sent Class model: Model of hardware that can be obtained for home automation Plural form: models Properties: <Inheritance> item [r/o] -- All of the properties of the superclass. asDictionary record -- internal data shoppingURLs list -- Web locations where you may be able to get this model of hardware manufacturer Unicode text -- The company that makes this model of hardware name Unicode text -- The name used by the manufacturer, such as "PowerLinc V2" modelNumber Unicode text -- The unique "number" of the model, such as "CM-15A" Class openAction: Opens Mac files or folders Plural form: openActions Elements: itemLocation by numeric index, before/after another element, as a range of elements, satisfying a test Properties: <Inheritance> macAction [r/o] -- All of the properties of the superclass. Class playSoundAction: Plays a sound Plural form: playSoundActions Properties: <Inheritance> macAction [r/o] -- All of the properties of the superclass. name Unicode text -- short name of the sound, like "Glass" or full path to a sound file Class port: The USB or serial port where a controller may be attached to your Mac Plural form: ports Properties: < item [r/o] -- All of the properties of the superclass. name Unicode text -- Name of the controller's port Class responder: Performs actions in response to something Plural form: responders Elements: action by numeric index, before/after another element, as a range of elements, satisfying a test Properties: <Inheritance> 'SItm' [r/o] -- All of the properties of the superclass. id Unicode text [r/o] -- string uniquely identifying this event trigger action -- action that triggers the responder to perform notes Unicode text -- These are your own notes about the responder. name Unicode text -- the name of the responder Class schedule: contains timed events and responders; carried out by a controller or the Mac Plural form: schedules Elements: responder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID event by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID Properties: <Inheritance> item [r/o] -- All of the properties of the superclass. name Unicode text -- name of the schedule is "Mac" or the name of the controller carrying it out Class scheduleSet: set of schedules that can be selected together Plural form: scheduleSets Elements: schedule by name, by numeric index, before/after another element, as a range of elements, satisfying a test Properties: <Inheritance> item [r/o] -- All of the properties of the superclass. name Unicode text [r/o] -- name of the schedule set; e.g. "Normal", "Vacation", "Holiday" Class scriptAction: runs a script Plural form: scriptActions Properties: <Inheritance> macAction [r/o] -- All of the properties of the superclass. script Unicode text -- text or file path of the script brighten: Brightens the light(s) brighten reference -- the object for the command [by integer] -- Percent to brighten the light(s). Default is 35%. [to integer] -- Final brightness level (percent) Result: anything -- the reply for the command dim: Dims the light(s) dim reference -- the object for the command [by integer] -- Percent to dim the light(s). Default is 35%. [to integer] -- Final brightness level (percent) Result: anything -- the reply for the command log: append text to the log log Unicode text -- the text to append to the log Result: anything -- the reply for the command perform: Causes an Event or Responder to perform its actions perform reference -- the object for the command sunrise: time of sunrise on the given day. default is for today sunrise [for date] -- the date of the sunrise Result: date -- the reply for the command sunset: time of sunrise on the given day. default is for today sunset [for date] -- the date of the sunset Result: date -- the reply for the command turn off: Turns off the device(s) turn off reference -- the object for the command Result: anything -- the reply for the command turn off all lights: Turns off all X-10 lights for the default house code. turn off all lights reference -- the object for the command Result: anything -- the reply for the command turn off all units: Turns off all X-10 units for the default house code. turn off all units reference -- the object for the command Result: anything -- the reply for the command turn on: Turns on the device(s). turn on reference -- the object for the command turn on all lights: Turns on all X-10 lights for the default house code. turn on all lights reference -- the object for the command Result: anything -- the reply for the command

To see these terms in use, browse the Script Examples

You can do each step above individually by following the links to the detailed procedures. If you prefer, Thinking Home can walk you through a basic setup of controllers and devices, then schedules.

Walk me through the basic setup