Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation #2

Open
wants to merge 1,121 commits into
base: master
Choose a base branch
from
Open
Changes from 2 commits
Commits
Show all changes
1121 commits
Select commit Hold shift + click to select a range
cdf0c2c
[DOCS-355] document SMS rate limiting
jimmyjames Oct 6, 2016
540a445
DOCS-356 updating XML files and the jinja template
unixbeast Oct 7, 2016
24eb3a2
Merge pull request #428 from unixbeast/capability-gen
unixbeast Oct 7, 2016
e21444e
typo: device types: ZibBee -> ZigBee
posborne Oct 9, 2016
6331145
Merge pull request #429 from posborne/fix-typo-zibbee
unixbeast Oct 10, 2016
b2ce852
Merge pull request #426 from jimmyjames/sms-rate-limiting
jimmyjames Oct 11, 2016
44a28d7
change log for 11 October release
jimmyjames Oct 11, 2016
8e9907a
Merge pull request #430 from jimmyjames/release-11-october-2016
jimmyjames Oct 11, 2016
b1f9643
[DOCS-345] - Break out the rate limits documentation into its own guide.
Oct 7, 2016
36bcca2
Merge pull request #432 from rajkaramchedu/rate-limits-guide
jimmyjames Oct 11, 2016
fd32273
Minor edits: sentence rewording
Oct 12, 2016
832ea6c
Getting switch.properties and colorControl.properties up to date
unixbeast Oct 12, 2016
b0f2a5b
Merge pull request #434 from unixbeast/capability-gen
unixbeast Oct 12, 2016
d4e69f4
Merge pull request #433 from rajkaramchedu/minor-edits-anatomy-doc
jimmyjames Oct 12, 2016
4d02e1b
fixing broken references
unixbeast Oct 12, 2016
705cf34
Merge pull request #435 from unixbeast/capability-gen
unixbeast Oct 12, 2016
471eea5
[DOCS-363] Copy edits for architecture page
Oct 12, 2016
1df2270
Merge pull request #436 from rajkaramchedu/minor-edits-arch-doc
jimmyjames Oct 13, 2016
9d9f0aa
[DOCS-345] Rate limits guide cleanup
Oct 13, 2016
76be70e
Merge pull request #437 from rajkaramchedu/rate-limits-guide-cleanup
jimmyjames Oct 13, 2016
1e2e595
Change log for 13 October 2016 docs release
jimmyjames Oct 13, 2016
0557cde
Merge pull request #438 from jimmyjames/release-13-october-2016
jimmyjames Oct 13, 2016
8fdbd09
Sentence rewording, minor edits
Oct 13, 2016
9c923cc
Merge pull request #440 from rajkaramchedu/gs-minor-doc-changes
jimmyjames Oct 14, 2016
be2d627
[DOCS-254] Documentation for the beta Async HTTP APIs
jimmyjames Oct 17, 2016
9263358
Merge pull request #441 from jimmyjames/async-http-api
jimmyjames Oct 17, 2016
f5c4760
release notes for 17 October 2016 docs release
jimmyjames Oct 17, 2016
9dc8bda
Merge pull request #442 from jimmyjames/17-october-2016-release
jimmyjames Oct 17, 2016
2d3a128
[DOCS-344] - refactor reference API docs to use getter style
jimmyjames Oct 18, 2016
b15afd3
Merge pull request #444 from jimmyjames/ref-docs-getter-refactor
jimmyjames Oct 18, 2016
c6a47ca
[DOCS-344] - add docs for getAllChildApps() methods and their derivat…
jimmyjames Oct 18, 2016
d5fb644
updates based on review comments.
jimmyjames Oct 19, 2016
3db99ba
findChildAppByName may return null
jimmyjames Oct 19, 2016
4042a34
Minor fixes in Prefs
Oct 18, 2016
f8a793c
Merge pull request #446 from rajkaramchedu/prefs-doc-minor-fixes
jimmyjames Oct 19, 2016
8bcfff5
[DOCS-367] - add additional lock attribute values
jimmyjames Oct 24, 2016
3eef7aa
Merge pull request #447 from jimmyjames/lock-capability-attr-values
jimmyjames Oct 24, 2016
39686be
Added nextOccurrence() reference
Oct 25, 2016
f675add
Merge pull request #449 from rajkaramchedu/smartapp-api-ref
jimmyjames Oct 25, 2016
d1cc5ca
Merge pull request #445 from jimmyjames/get-child-apps
jimmyjames Oct 25, 2016
7b759bf
[DOCS-344] clarify getting installation state for child smartapp
jimmyjames Oct 26, 2016
a99e3c3
Merge pull request #451 from jimmyjames/clarify-child-apps
jimmyjames Oct 26, 2016
7d1fc59
Release notes for 26 october docs release
jimmyjames Oct 26, 2016
bb47578
Merge pull request #452 from jimmyjames/oct-26-release-notes
jimmyjames Oct 26, 2016
2d874ab
Revised timeTodayAfter() method description
Oct 26, 2016
3306264
Merge pull request #454 from rajkaramchedu/timetodayafter-revised
jimmyjames Oct 26, 2016
a1c1afd
Documenting time window use case
Oct 27, 2016
e5aa80b
Merge pull request #455 from rajkaramchedu/execute-in-time-window
jimmyjames Oct 27, 2016
e3f30d4
logic table fix
Oct 31, 2016
25b4acb
[DOCS-366] fix up scheduling reference docs
jimmyjames Nov 1, 2016
309a1d7
Merge pull request #458 from jimmyjames/scheduling-parity
jimmyjames Nov 1, 2016
4f749c7
Adding usecase of executing on certain days-of-week
Nov 1, 2016
7b00374
[DOCS-372] clarify getting latest device state
jimmyjames Nov 2, 2016
a2e59f1
Merge pull request #460 from jimmyjames/clarify-device-states
jimmyjames Nov 2, 2016
cee2669
Corrected timeZone() method description
Nov 3, 2016
4f601c0
Merge pull request #461 from rajkaramchedu/fix-timezone-doc-error
jimmyjames Nov 3, 2016
08dbc5f
Merge pull request #456 from rajkaramchedu/doc-updates-for-timeOfDayI…
unixbeast Nov 3, 2016
8d0f26f
Merge pull request #457 from rajkaramchedu/document-executing-on-cert…
unixbeast Nov 3, 2016
c5edb26
03 November 2016 Release notes
unixbeast Nov 3, 2016
b71a6a8
Merge pull request #462 from unixbeast/release-03-nov-2016
unixbeast Nov 3, 2016
fc01c8d
DOCS-374 Noticed I had to update the template to support required arg…
unixbeast Nov 4, 2016
6f5cb2a
Merge pull request #464 from unixbeast/template
unixbeast Nov 7, 2016
d7cc14a
[DOCS-391] - fix build warnings
jimmyjames Nov 8, 2016
5da6cdf
Merge pull request #467 from jimmyjames/build-warnings-cleanup
jimmyjames Nov 8, 2016
5c2b4f2
[DOCS-396] styles consistent with developer.smartthings.com
jimmyjames Nov 8, 2016
d3ac86b
Merge pull request #469 from jimmyjames/style-tweaks
jimmyjames Nov 10, 2016
4342af5
[DOCS-361] document manufacturer and model name on device
jimmyjames Nov 8, 2016
1ce69df
[DOCS-396] accidentally set the pygments style in earlier PR; fixing …
jimmyjames Nov 10, 2016
96f90c3
Merge pull request #470 from jimmyjames/fix-whoops
jimmyjames Nov 10, 2016
733fbf2
DOCS-376 updating template to correct missing content
unixbeast Nov 10, 2016
453a9bb
Merge pull request #471 from unixbeast/template
unixbeast Nov 10, 2016
7879bf7
Merge pull request #466 from jimmyjames/manufacturer-model-info
jimmyjames Nov 10, 2016
0c241f9
release notes for 10 November release
jimmyjames Nov 10, 2016
5510255
Merge pull request #472 from jimmyjames/release-10-november-2016
jimmyjames Nov 10, 2016
2476e15
Added warning in Simulator section
Nov 10, 2016
d9ab334
Merge pull request #474 from rajkaramchedu/add-simulator-warnings
jimmyjames Nov 11, 2016
c9b6ff6
Squashing two commits into one.
Nov 10, 2016
b1c150d
Merge branch 'master' of https://github.com/rajkaramchedu/Documentati…
Nov 11, 2016
2d55094
Fixing lex warnings
unixbeast Nov 11, 2016
3cc2dc7
Merge pull request #477 from unixbeast/warnings
unixbeast Nov 12, 2016
9c5e876
Add ability to copy code blocks
jimmyjames Nov 11, 2016
8926f6e
Merge pull request #475 from rajkaramchedu/time-zone-doc
jimmyjames Nov 14, 2016
152a628
Merge pull request #478 from jimmyjames/copy-code-blocks
jimmyjames Nov 14, 2016
d3798c4
release notes for 14 November 2016 release
jimmyjames Nov 14, 2016
3cac21f
Merge pull request #479 from jimmyjames/release-notes-14-november
jimmyjames Nov 14, 2016
c04eed1
Added dynamicPage() params description
Nov 14, 2016
84a737d
Revert "Add ability to copy code blocks"
jimmyjames Nov 14, 2016
a9966c1
Merge pull request #482 from jimmyjames/revert-copy-code
jimmyjames Nov 14, 2016
c490c3c
release notes for 14 November (take 2)
jimmyjames Nov 14, 2016
7681f0b
Merge pull request #483 from jimmyjames/release-notes-14-november-2
jimmyjames Nov 14, 2016
bd100a7
Copy code blocks to clipboard, take 2.
jimmyjames Nov 14, 2016
eea59ff
fix more build warnings
jimmyjames Nov 15, 2016
f349792
Merge pull request #486 from jimmyjames/fix-toc-tree-warning
jimmyjames Nov 15, 2016
2b89c8e
DOCS-380 noticed incorrect indentation and fixed it
unixbeast Nov 15, 2016
57cc46f
Merge pull request #487 from unixbeast/quick-template-fix
unixbeast Nov 15, 2016
86e89b8
Merge pull request #485 from jimmyjames/fix-copy-code-block
jimmyjames Nov 15, 2016
877f28c
release notes for 15 November
jimmyjames Nov 15, 2016
537aebb
Merge pull request #488 from jimmyjames/release-notes-15-november
jimmyjames Nov 15, 2016
099506d
DOCS-381 fixing displayed attribute if there is only one
unixbeast Nov 16, 2016
dbde371
Merge pull request #491 from unixbeast/attribute-fix
unixbeast Nov 16, 2016
c03bcc2
copy code block style changes
jimmyjames Nov 18, 2016
c9244a7
Merge pull request #492 from jimmyjames/copy-button-style-tweaks
jimmyjames Nov 18, 2016
aefaef3
dark code block theme
jimmyjames Nov 17, 2016
b9a7720
Merge pull request #493 from jimmyjames/monokai-dark
jimmyjames Nov 18, 2016
789e6c9
release notes for 17 november 2016
jimmyjames Nov 18, 2016
fda63ab
Merge pull request #494 from jimmyjames/17-november-release
jimmyjames Nov 18, 2016
fc2f0ed
DOCS-385 adding support for command argument values to template
unixbeast Nov 18, 2016
a552563
Merge pull request #496 from unixbeast/docs-385
unixbeast Nov 18, 2016
5b10790
Merge pull request #481 from rajkaramchedu/dynamic-page-doc
jimmyjames Nov 22, 2016
c504337
DOCS-386 fixing spacing/newline issues in template
unixbeast Nov 22, 2016
5dcba8b
Merge pull request #499 from unixbeast/DOCS-386
unixbeast Nov 22, 2016
883926e
DOCS-387 adding a missing label
unixbeast Nov 22, 2016
02c68d9
Add documentation for ZCL message classes
varzac Aug 31, 2016
53de9b5
Merge pull request #500 from unixbeast/docs-387
unixbeast Nov 23, 2016
c82f17a
DOCS-402 adding support for optional attributes
unixbeast Nov 29, 2016
5aa91b7
Merge pull request #503 from unixbeast/docs-402
unixbeast Nov 29, 2016
56c3d0e
Image layout adjustments
Nov 28, 2016
a455df7
Merge pull request #502 from rajkaramchedu/state-image-rev
jimmyjames Nov 29, 2016
0384635
Adding missing images
Nov 30, 2016
31e9e59
Merge pull request #504 from rajkaramchedu/fix-missing-images
jimmyjames Nov 30, 2016
9d81e13
30 November release
unixbeast Nov 30, 2016
28e3c3c
Merge pull request #505 from unixbeast/release-30-nov-2016
unixbeast Nov 30, 2016
8b4cdec
Update ZigBee Primer to not use raw strings
varzac Nov 23, 2016
90b3d1f
DOCS-415 correcting some issues with template
unixbeast Dec 1, 2016
8798fd0
Merge pull request #508 from unixbeast/template
unixbeast Dec 1, 2016
0db4e33
DOCS-415 alphabetize table
unixbeast Dec 1, 2016
514cbc0
Merge pull request #510 from unixbeast/template
unixbeast Dec 1, 2016
9d34986
Merge pull request #497 from varzac/ZCL-message-docs
jimmyjames Dec 2, 2016
b8da93e
fix typo in httpPostJson docs
jimmyjames Dec 2, 2016
26e520f
DOCS-416 adding data type descriptions
unixbeast Dec 2, 2016
528a166
Merge pull request #512 from jimmyjames/fix-typo
jimmyjames Dec 2, 2016
3a7f91d
Merge pull request #513 from unixbeast/datatypes
unixbeast Dec 2, 2016
63fb0a2
DOCS-404 switching over to generated capability documentation
unixbeast Dec 5, 2016
469153e
Merge pull request #515 from unixbeast/release_capabilities
unixbeast Dec 5, 2016
df7fcdd
Changed "Important::" to "important::" in reStructureText
Dec 5, 2016
4057df6
Merge pull request #516 from rajkaramchedu/lowercase-repo-folder
Dec 7, 2016
8a61cf6
Further edited the description for better readability.
Dec 7, 2016
994575e
Merge pull request #517 from rajkaramchedu/hubs-and-locations
Dec 7, 2016
3e5d421
Dec 08 2016 release
unixbeast Dec 8, 2016
2654f4f
Merge pull request #518 from unixbeast/release-08-dec-2016
unixbeast Dec 8, 2016
92b88b1
some minor visual changes to capabilities reference template
jimmyjames Dec 8, 2016
384b0c5
Merge pull request #520 from jimmyjames/remove-colons
jimmyjames Dec 8, 2016
7ecd488
Modified allowable characters for SECONDS field and clarified that fa…
Dec 9, 2016
0f83d51
Merge pull request #521 from rajkaramchedu/cron-schedule-doc
Dec 15, 2016
34bdac8
fix broken links
jimmyjames Dec 20, 2016
a66142b
Merge pull request #525 from jimmyjames/fix-broken-link
jimmyjames Dec 20, 2016
994894e
Modified "Example" description
Dec 12, 2016
831a11d
Deleted previous pages on submitting for review, worked in review com…
Dec 21, 2016
34d5e4c
fix grammar error
jimmyjames Jan 3, 2017
a168534
Merge pull request #531 from jimmyjames/grammar-error-530
jimmyjames Jan 3, 2017
1190fcb
Merge pull request #526 from rajkaramchedu/remove-shard-confusion
jimmyjames Jan 3, 2017
a4e2dbb
Merge pull request #523 from rajkaramchedu/sendhubcommand-doc
jimmyjames Jan 3, 2017
fd085fc
change log for 03 january 2017 docs release
jimmyjames Jan 3, 2017
c0b2084
Merge pull request #532 from jimmyjames/release-03-jan-2017
jimmyjames Jan 3, 2017
151f289
[DOCS-429] Replace remaining instances of Device Type Handler with De…
jimmyjames Jan 4, 2017
a56f9d2
Merge pull request #534 from jimmyjames/consistent-terminology
jimmyjames Jan 4, 2017
c4c15ab
fix Event::getData() documentation
germasch Jan 5, 2017
36cdf32
Merge pull request #535 from germasch/fix-event-getdata
jimmyjames Jan 5, 2017
3174629
deprecate arduino docs (#537)
jimmyjames Jan 5, 2017
c373427
[DOCS-434] add warning that github may slow IDE (#540)
jimmyjames Jan 13, 2017
5a2a451
fixed spello for word request (#542)
Jan 18, 2017
dbb5ca7
Renamed "Whats New" doc to "Latest Updates"; modified last 4 release …
Jan 19, 2017
32b13aa
[DOCS-441] add getAccountId to IntalledSmartAppWrapper ref doc (#544)
jimmyjames Jan 20, 2017
2fbc8bc
Merge pull request #543 from rajkaramchedu/create-whats-new
Jan 20, 2017
198cdf0
Fixed "protocol" parameter description; added a note on difference in…
Jan 23, 2017
73cd9e8
Docs release for 23 January 2017 (#546)
jimmyjames Jan 23, 2017
2b553e0
Modified the blurb for HubAction (#548)
Jan 30, 2017
fea729f
Add getLastActivityDate and getStatus to Device (#549)
vl4ds Jan 31, 2017
024d386
[DOCS-293] Z-Wave Fingerprinting Changes (#550)
mckeed Feb 5, 2017
cff2de1
[DOCS-450] - emphasize using runEvery* instead of cron. (#552)
jimmyjames Feb 7, 2017
741ef4f
Reduced image sizes; modified the note. (#551)
Feb 7, 2017
6a6da35
Use button instead of tooltip for copy code (#553)
jimmyjames Feb 8, 2017
822fd0d
Release notes for 08 February docs release. (#555)
jimmyjames Feb 8, 2017
4610175
[DOCS-425] - more user-friendly docs homepage (#557)
jimmyjames Feb 9, 2017
03315b5
docs release for 10 Feb 2017 (#559)
jimmyjames Feb 10, 2017
4bb3427
fix hasError docs (#562)
jimmyjames Feb 13, 2017
0250308
Updating docs with infraredLevel capabilities changes (#566)
Feb 16, 2017
2e5330f
[DOCS-454] add more info around the app input element (#565)
jimmyjames Feb 17, 2017
18096ab
fix getChildDevices example (#567)
jimmyjames Feb 21, 2017
6ab8f1f
[DOCS-428] - document conversion methods on ColorUtilities (#561)
jimmyjames Feb 22, 2017
74f1639
DOCS-452 Add runEvery1Minute to Device/SmartApp Scheduling API (#554)
rappleg Feb 22, 2017
aabb4a4
Worked in Jim's comments. (#568)
Feb 23, 2017
95cca0e
Revised the entire style guide for title and heading styles.
Feb 24, 2017
9624548
Merge pull request #569 from rajkaramchedu/style-guide-titles-etc
Feb 27, 2017
f544159
Fixed "location" to "Location"
Feb 27, 2017
22399c0
Merge pull request #573 from rajkaramchedu/update-arch-rate-pub
Feb 28, 2017
ee7fd15
Style fixes for titles and section headings
Feb 28, 2017
ecaa346
Merge pull request #574 from rajkaramchedu/style-update-getting-started
Feb 28, 2017
b3dfd56
Modified State doc title (#575)
Mar 1, 2017
ccc945e
style updates for titles and section headings (#578)
Mar 2, 2017
52c5f88
titles and section heading style updates (#577)
Mar 2, 2017
d812509
style updates for titles and section headings (#576)
Mar 2, 2017
7d12ce4
button capability updated; bridge capability added. (#579)
jimmyjames Mar 2, 2017
e35e43f
Release notes for 02 march 2017 docs release (#580)
jimmyjames Mar 2, 2017
2322f01
[DOCS-438] add create and revoke token reference docs (#581)
jimmyjames Mar 2, 2017
47debd5
fix for title underline build warning (#584)
jimmyjames Mar 3, 2017
a241212
Fixed rst code block for the example. (#583)
Mar 7, 2017
10e325f
UI elements style updated (#585)
Mar 7, 2017
ca0f028
adding list style guide section
Mar 7, 2017
1d9fdb6
Merge pull request #589 from rajkaramchedu/style-lists
Mar 7, 2017
39a732d
[DOCS-464] style guide for api docs (#588)
jimmyjames Mar 7, 2017
6e5bd6f
[DOCS-460] update publication for public distribution docs (#592)
jimmyjames Mar 8, 2017
1f9f506
fix statesSince example (#590)
jimmyjames Mar 8, 2017
5f03a7c
Modified the KB article link to go to KB region automatically. (#587)
Mar 8, 2017
2680794
release notes for 08 march 2017 (#593)
jimmyjames Mar 8, 2017
bb4f246
Took out periods after links for list elements.
Mar 8, 2017
aec522e
Merge pull request #595 from rajkaramchedu/docs-scrub-list-styling
Mar 9, 2017
a43892d
[DOCS-463] Revised docs to update glossary terms (#597)
Mar 14, 2017
cf9f54d
glossary of ST terms (#596)
Mar 14, 2017
1491ed6
Worked in Bob F.'s comments. (#558)
Mar 14, 2017
dfd2244
[DOCS-465] - document new tile color standards and update all example…
jimmyjames Mar 22, 2017
23f8571
release notes for 22 march docs release (#599)
jimmyjames Mar 22, 2017
9bd1ac8
few clarifications for addChildDevice, add getChildDevices and getDev…
jimmyjames Apr 10, 2017
cef57c9
[DOCS-440] - document capturing and displaying images from cameras. (…
jimmyjames Apr 17, 2017
b16db96
[DOCS-468] document child install limits (#604)
jimmyjames Apr 20, 2017
7da718b
docs release notes for 20 april 2017 (#606)
jimmyjames Apr 20, 2017
b125c41
sync with latest released capabilities and update favicon (#609)
jimmyjames May 4, 2017
6620f15
[DOCS-469] Composite tiles document (#605)
May 4, 2017
ebaad87
[DOCS-470] Add fire-and-forget verbiage to the smart-apps documentati…
aaron-miller May 4, 2017
40b4b7c
release notes for may 04 2017 docs release (#610)
jimmyjames May 4, 2017
d86bec6
fix formatting of latest updates page (#612)
jimmyjames May 10, 2017
d224390
Typo fix: thought ➡ though (#616)
CosmicPuppy May 30, 2017
c49144e
Fixed HubAction HOST param doc and removed beginning ---- transition …
Jun 6, 2017
890f02e
Updated battery capability definition (#619)
jimmyjames Jun 8, 2017
cbd3199
release notes for June 08 docs release (#620)
jimmyjames Jun 8, 2017
f5a8822
Fix minor typo in z-wave documentation (#622)
DMor1 Jun 14, 2017
fae9f04
add new logo img file (#623)
Jun 20, 2017
dca0c83
Thermostat-related Capabilities updates (#625)
Jul 6, 2017
6b62b11
release notes for July 07 2017 docs release (#626)
Jul 7, 2017
d942b6a
Update devices.rst (#630)
adamkempenich Jul 31, 2017
27f0483
added boolean data type description (#633)
darksun Aug 9, 2017
3c7d38b
add 'getTypeName' to Device documentation (#631)
danroot Aug 9, 2017
67eb222
target master for small typo fix in #635 (#636)
Aug 14, 2017
9115842
add custom theme template (#638)
Oct 12, 2017
8b094d6
try adding local settings (#639)
Oct 12, 2017
f38edf1
[DEVP-285] add warning that capabilities docs here no longer maintain…
Jan 3, 2018
ac95c9b
remove legacy capabilities docs generation (#644)
Jan 20, 2018
8444e4e
Update up-and-running.rst (#640)
annieprentice Jan 23, 2018
1229d85
Edited the Account creation URL
Rooks103 Apr 5, 2018
b72b4ce
[DOCS-517] put back some basic capabilities docs in legacy site (#649)
May 8, 2018
56bbd30
Merge pull request #648 from SmartThingsCommunity/Rooks103-patch-1
Rooks103 Jul 30, 2018
7100d50
Disclaimer in the schedule docs to avoid private scoped methods and p…
rappleg Sep 8, 2018
db4e1c8
Merge pull request #656 from rappleg/UpdateScheduleMethodInDocsToAvoi…
rappleg Sep 8, 2018
42b5cbe
Add redirect notice banner (#657)
erodewald Oct 31, 2018
6836339
Fix selector style that displaced links when trying to click them (#658)
erodewald Oct 31, 2018
90e82dd
Fix selector style that displaced links when trying to click them (#659)
erodewald Nov 1, 2018
110486a
Add '_static' to html_static_path
erodewald Dec 21, 2018
b34eb29
Merge pull request #661 from erodewald/fix-make-html
erodewald Dec 21, 2018
bb748b2
Deprecate getWeatherFeature and add new weather API docs (#662)
Dec 24, 2018
cc61c72
fix broken distribution link (#663)
Mar 5, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 12 additions & 47 deletions smartapp-developers-guide/anatomy-and-life-cycle-of-a-smartapp.rst
Original file line number Diff line number Diff line change
@@ -5,14 +5,15 @@ Anatomy & Life-Cycle of a SmartApp

SmartApps are applications that allow users to tap into the capabilities of
their devices to automate their lives.
Most SmartApps are installed by the user via the SmartThings mobile client application, though some come pre-installed.
Most SmartApps are installed by the user via the SmartThings mobile client application. In addition, a few pre-installed SmartApps are readily available in the SmartThings system out-of-the-box.

----

Types of SmartApps
------------------

Generally speaking, there are three different kinds of SmartApps: *Event-Handlers*, *Solution Modules*, and *Service Managers*.
If you are familiar with back-end web development, then you will be more than capable of developing SmartApps.

Event-Handler SmartApps
^^^^^^^^^^^^^^^^^^^^^^^
@@ -23,10 +24,9 @@ They allow you to subscribe to events from devices and call a
handler method upon their firing.
This method can then do a variety of
things, most commonly invoking a command on another device.
We're confident that if you are familiar with back end development of web
sites, then you will be more than capable of developing SmartApps.

A very simple example of a SmartApp would involve you walking through a

A very simple example of an Event-Handler SmartApp would involve you walking through a
door and having the lights turn on automatically.

Solution Module SmartApps
@@ -41,21 +41,17 @@ One example of this would be the "Home & Family" section of
the dashboard which allows you to see the comings and goings of your
family.

Solution Module SmartApps have traditionally been built by our internal
team, but we will be opening them up for external development in the
near future.

Service Manager SmartApps
^^^^^^^^^^^^^^^^^^^^^^^^^

Service Manager SmartApps are used to connect to LAN or cloud devices,
such as the Sonos or WeMo.
They are the connecting glue between the unique protocols of your external devices and a Device Handler you'd create for those devices.
They discover devices and then continue to maintain the connection for those devices.
such as a Sonos or a WeMo device.
These SmartApps are the connecting glue between the unique protocols of such LAN or cloud devices and a Device Handler you would create for such devices.
These Service Manager SmartApps discover LAN or cloud devices and then continue to maintain their connection.

The Service Manager SmartApp must be installed when a user utilizes a
device using LAN or the cloud, so for example, there is a Sonos Service
Manager SmartApp that is installed when pairing with a Sonos.
device using LAN or the cloud. So, for example, there is a Sonos Service
Manager SmartApp that is installed when pairing with a Sonos device.

----

@@ -88,7 +84,7 @@ The following methods, if present, are automatically called at various times dur
#. ``installed()`` - Called when a SmartApp is first installed
#. ``updated()`` - Called when the preferences of an installed smart app are updated
#. ``uninstalled()`` - Called when a SmartApp is uninstalled.
#. ``childUninstalled()`` - Called for the parent app when a child app is uninstalled
#. ``childUninstalled()`` - Called for the parent app when a child app is uninstalled (a SmartApp can have child SmartApps)

The ``installed()`` and ``updated()`` methods are commonly found in all apps.
Since the selected devices may have changed when an app is updated, both of these methods typically set up the same event subscriptions, so it is common practice to put those calls in an ``initialize()`` method and call it from both the installed and updated methods.
@@ -141,7 +137,7 @@ For example, to specify that an app requires one contact sensor:
This will generate an input element in the mobile UI that prompts for the selection of a single contact sensor (``capability.contactSensor``).
``contact1`` is the name of a variable that provides access to the device in the SmartApp.

Device inputs can also prompt for more than one device, so to ask for the selection of one or more switches:
Device inputs can also prompt for more than one device. So to ask for the selection of one or more switches:

.. code-block:: groovy

@@ -154,7 +150,7 @@ You can find more information about SmartApp preferences `here <preferences-and-
Event Subscriptions
-------------------

Subscriptions allow a SmartApp to listen for events from devices, the location, and the SmartApp tile in the mobile UI.
Subscriptions allow a SmartApp to listen for events from devices, or from a location, or from the SmartApp tile in the mobile UI.
Device subscriptions are the most common and take the form:

.. code-block:: groovy
@@ -198,34 +194,3 @@ Execution location varies depending on a variety of factors, and is managed by t

As a SmartThings developer, you should write your SmartApps to satisfy their specific use cases, regardless of where the app executes.
There is currently no way to specify or force a certain execution location.

----

.. _smartapp_rate_limiting:

Rate Limiting
-------------

SmartApps are monitored for excessive resource utilization.
Rate limiting ensures that no single SmartApp can consume too many shared resources.

Execution Time Limits
^^^^^^^^^^^^^^^^^^^^^

- Methods are limited to a continuous execution time of 20 seconds.
- SmartApps and Device Handlers are limited to a total continuous execution time of 40 seconds.

If these limits are exceeded, the current execution will be suspended.

Execution Count Limits
^^^^^^^^^^^^^^^^^^^^^^

SmartApps are limited to executing no more than 250 times in 60 seconds.
If the limit is reached in a 60 second time window, no further exceptions will occur until the next time window.
A log entry will be created for the SmartApp that was rate limited.

.. note::

The common cause for exceeding the 250 executions within 60 seconds limit is excessive subscriptions. This may be an infinite loop of events (for example, subscribing to an "on" and "off" event, and the "on" command actually triggers the "off" event and vice versa - leading to a never-ending chain of event handlers being called). It's also possible that a SmartApp that subscribes to a very large number of particularly "chatty" devices may run into this limit.

Additional rate limiting restrictions apply to SmartApps or Device Handlers that expose endpoints via the ``mappings`` definitions. You can learn about those in the `SmartApp Web Services Guide <../smartapp-web-services-developers-guide/overview.html>`__.