Latest Updates¶

July 07 2017¶

Changes to the thermostatCoolingSetpoint Capability:

coolingSetpointMin and coolingSetpoingMax attributes replaced with coolingSetpointRange.

Changes to the thermostatFanMode Capability:

supportedThermostatFanModes attribute added.

Changes to the thermostatHeatingSetpoint Capability:

heatingSetpointMin and heatingSetpointMax attributes replaced with heatingSetpointRange.

Changes to the thermostatMode Capability:

supportedThermostatModes attribute added.

Changes to the thermostatSetpoint Capability:

thermostatSetpointMin and thermostatSetpointMax attributes replaced with thermostatSetpointRange.

Changes to the thermostat Capability:

coolingSetpointMin and coolingSetpointMax attributes replaced with coolingSetpointRange.
heatingSetpointMin and heatingSetpointMax attributes replaced with heatingSetpointRange.
thermostatSetpointMin and thermostatSetpointMax attributes replaced with thermostatSetpointRange.
supportedThermostatFanModes attribute added.
supportedThermostatModes attribute added.

GitHub Release Tag

June 08 2017¶

HubAction reference documentation updated to clarify that HOST parameter is part of the headers map.

GitHub Release Tag

May 04 2017¶

Asynchronous HTTP requests now support optional response handler methods. For cases when you just need to make a request, but don’t care about the response, just pass null for the response handler. Docs updated here.
Creating a Composite Device Handler? Check out the new Composite Device Tiles documentation!
Some changes and additions to several Capabilities:
- getAllActivities() and getCurrentActivity() Commands removed from mediaController Capability.
- startActivity() Command updated to accept the ID of the activity, instead of the name.
- Optional coolingSetpointMin and coolingSetpointMax attributes added to the thermostatCoolingSetpoint Capability.
- Optional heatingSetpointMin and heatingSetpointMax attributes added to the thermostatHeatingSetpoint Capability.
- Optional thermostatSetpointMin and thermostatSetpointMax attributes added to the thermostatSetpoint Capability.
- Optional coolingSetpointMin, coolingSetpointMax, heatingSetpointMin, heatingSetpointMax, thermostatSetpointMin, and thermostatSetpointMax attributes added to the thermostat Capability.

GitHub Release Tag

April 20 2017¶

Image capturing and viewing documentation is here! Learn how to store, retrieve, and display images from a LAN- or Cloud-connected camera device.
Updated Rate Limiting documenation with new child SmartApp and Device Handler limits, as well as clarify existing rate limits.

GitHub Release Tag

March 22 2017¶

Composite Devices are here! Composite Devices allow developers to better model devices through a parent-child relationship between Device Handlers. Check out the documentation and leverage this new design pattern for your composite devices!
PEA HiVE has a new set of color standards for Device Handler Tiles. The Color standards documentation covers all the new color standards.
Updates to the Writing Style Guide and existing documentation to conform to new guidelines.

GitHub Release Tag

March 08 2017¶

Do you have custom LAN device integrations? If so, check out the Automatic LAN Device Discovery documentation to see what (if any) impact this has on your custom code.

GitHub Release Tag

March 02 2017¶

Does your SmartApp or Device Handler need to execute every minute? Instead of writing your own cron expression, use the new runEvery1Minute()!
Need to convert color values between hexadecimal and RGB? The ColorUtilities class has what you need.
If you are writing a parent-child SmartApp, check out the expanded and clarified documentation for using the app() input type.
A new capability, bridge, allows devices to declare they act as a bridge to other devices.
A new attribute, held, has been added to the button capability!
The Writing Style Guide has been updated with guidelines for document title and headings capitalization and formatting. If you are a contributor to these docs, make sure you check it out!

GitHub Release Tag

February 10 2017¶

Did you notice? We’ve updated the docs homepage to help readers quickly identify and navigate to common areas of interest.

GitHub Release Tag

February 08 2017¶

Z-Wave fingerprinting updates! The Z-Wave fingerprinting documentation has been expanded and updated with the latest information.
Get information about a Device’s status and last activity using the new getStatus() and getLastActivity() methods.
New to Device Handler development, or looking for a refresher? We’ve overhauled our Quick Start to ensure you can get up and running quickly and pain-free.
Do you use cron to create recurring schedules? Have you seen if you could replace that often-difficult to understand, write, and maintain cron expression with any of our runEvery* methods? We’ve updated the documentation to highlight these methods and encourage their use, instead of using cron.
Did you know you can copy code examples right to your clipboard? We updated the UX to increase the visibility of this handy feature.

GitHub Release Tag

January 23 2017¶

Search, discover and communicate with the devices in your network with the HubAction class. Check out the new reference document for HubAction.
If you need to get the account ID associated with an installed SmartApp, check out the getAccountId() method available on the InstalledSmartApp object!
We’ve updated the Editor and Simulator guide to clarify that you need to ensure you are on the correct shard when creating SmartApps or Device Handlers.
A new Capability, infraredLevel, is now available!

GitHub Release Tag

January 03 2017¶

Thinking about setting up a regular on and off schedule for your PEA HiVE? See our latest update, with examples, in Schedule using cron.
Confused about sharding and where to publish your SmartApp or Device Handler? Here is a big picture view that clarifies Publishing Custom Code.
Did you know there’s a default delay between commands when you send a sequence of them to the Hub? See sendHubCommand() reference documentation for details.

GitHub Release Tag

December 08 2016¶

Quick, how do you know what Capabilities are supported by PEA HiVE? Checkout out the new generated Capabilities Reference, now live.
Don’t know much about ZigBee? We got you covered with our updated ZigBee documentation in the ZigBee Primer and ZigBee Reference guides.
What you, as a developer, must know while working with the PEA HiVE IDE. Checkout latest in the Hubs and Locations guide.

GitHub Release Tag

November 30 2016¶

Did you know you can refresh any page of the SmartApp on the mobile device with a set interval? See the dynamicPage() options guide.

GitHub Release Tag

November 17 2016¶

Changed code blocks to use the monokai dark theme.

GitHub Release Tag

November 15 2016¶

Added ability to copy code blocks to the clipboard.

GitHub Release Tag

November 14 2016¶

GitHub Release Tag

Added documentation for working with time zones.
Fixed warnings related to lexical parsing of code blocks.

November 10 2016¶

GitHub Release Tag

Documented new getModelName() and getManufacturerName().
Styling and organiational changes to the left-hand navigation.
Internal build error fixes.

November 03 2016¶

GitHub Release Tag

Revised timeTodayAfter() method description in the SmartApp Guide
Added Working With Time guide to the SmartApp Developers Guide
Fixed up scheduling reference docs in Device Handler, and SmartApp Guides
Clarify getting latest device state in Device, and Working with Devices
Corrected timeZone() method description in the SmartApp Guide

October 26 2016¶

GitHub Release Tag

Documentation for nextOccurrence().
Documentation for getAllChildApps(), findAllChildAppsByName(), findAllChildAppsByNamespaceAndName(), findChildAppByNamespaceAndName(), and getAllChildApps().
Updated documentation for getChildApps() to reflect that only “complete” child app installations will be returned.
Changed reference API docs to use getter forms instead of property access.
New attribute values added for the lock capability.
Typo fixes and other copy edits.

October 17 2016¶

GitHub Release Tag

Documentation for beta asynchronous HTTP APIs
Typo fixes and other copy edits

October 13 2016¶

GitHub Release Tag

Moved rate limiting documentation into its own guide
Typo fixes and other copy edits

October 11 2016¶

GitHub Release Tag

Documented SMS rate limits
Fixed typos

October 06 2016¶

GitHub Release Tag

Added instructions for creating a simple code example when creating a developer support ticket.
Added documentation for specifying a custom Remove button for preferences.

October 05 2016¶

GitHub Release Tag

Added documentation for passing data to schedule handler methods.
Added best practices for parent-child relationships.
Updated the repository’s README with pull request guidelines.
Added scheduling APIs to the Device Handler reference documentation (including all runEvery* APIs, which are now supported in Device Handlers).
Fixed broken cron tutorial link the Scheduling guide.
Added note to the first SmartApp tutorial and Editor and Simulator that the Simulator is inconsistent with the mobile application.

September 23 2016¶

GitHub Release Tag

Added link to the Z-Wave public spec on the following Z-Wave pages: Building Z-Wave Device Handlers and Z-Wave Primer
Updated the Color Control capability to correctly reflect the capability definition.
Updated Jinja template to add some more features for the ongoing generated capability documentation project.
Fixed minor grammatical errors.

September 14 2016¶

GitHub Release Tag

Update to the State and Atomic State documentation to reorganize, clarify, and expand content.

September 09 2016¶

GitHub Release Tag

Removed Occupancy capability
Fixed unschedule() docs to clarify that a specific handler method name can be passed to unschedule().

September 02 2016 (3)¶

GitHub Release Tag

Fixing RTD build

September 02 2016 (2)¶

GitHub Release Tag

Fixing RTD build

September 02 2016¶

GitHub Release Tag

Typos and spelling fixes
Added more around the generated capabilities documentation framework
Added Troubleshooting document to the SmartApp Web Services guide
Fixed colorControl example code in the capabilities reference

August 17 2016¶

GitHub Release Tag

Fix documentation for subscribeToCommand() (only takes a Device argument, not a list of Devices)
Typos and spelling fixes

August 16 2016¶

GitHub Release Tag

Documentation for the ability to pass a Throwable to logging methods to get more logging details about the exception shown in the logs.

August 15 2016¶

GitHub Release Tag

Make edits to Makefile as a first step in getting generated capabilities documentation integrated into the documentation build.

August 04 2016¶

GitHub Release Tag

Added zigbee.parseZoneStatus() documentation
Added documentation for Additional ZigBee classes
Clarified findChildAppByName() API documentation
Added documentation to Device Handler Guide for other useful APIs available to Device Handlers, including Scheduling, HTTP Requests, and State.
Fixed documentation for Event.dateValue to indicate that it returns null if date cannot be parsed
Various fixes for reStructuredText formatting and legal syntax warnings
Moved this documentation change log to top of navigation

July 28 2016¶

GitHub Release Tag

Document the new hideWhenEmpty preferences option.

July 25 2016¶

GitHub Release Tag

Add a strong warning to the State documentation to emphasize the importance of never mixing atomicState and state in the same SmartApp.

July 21 2016¶

GitHub Release Tag

Documented the new redirect URI field on OAuth SmartApps

July 07 2016¶

GitHub Release Tag

Added documentation for working with collections in State and Atomic State.
Added documentation for AppState
Added documentation for InstalledSmartApp
Added clarification that the callable URL for Web Services SmartApps will vary by installed location
Updated developer call schedule