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

DOCS-284 - Updated tiles documentation #314

Merged
merged 3 commits into from May 24, 2016

Conversation

Projects
None yet
2 participants
@jimmyjames
Contributor

jimmyjames commented May 19, 2016

This also addresses tickets DOCS-229, DOCS-232, and DOCS-230.

This is a large rewrite and expansion of the Device Handler tiles docs.

The changes include:

  • Reorganization of content
  • Images updated to be consistent with the new mobile app UX
  • Expanded documentation of the different control tile types (color and slider)
  • Documented the color control's return values
  • Split out each type of Multi-Attribute tile into its own section
  • Added examples for reference and experimentation.

This commit does not include documentation on the Video tile. That work is captured in DOCS-296.

@pennig I'd like you to review this (it's a lot, so thank you in advance!) and/or delegate as needed.

/cc @unixbeast @mrnohr @KyleLeneau

Label Description
============================= ============
``label: '${currentValue}'`` The current value of this attribute's state. This is used when the attribute doesn't have a discrete value set, like temperature or power.
``label: '${name}'`` The name of the attribute state. This is useful when the attribute state is a discreet value, like "on" or "off".

This comment has been minimized.

@pennig

pennig May 23, 2016

Contributor

discrete


.. note::

The color of the multi-attribute tile is controlled by the PRIMARY_CONTROL tile attribute, or in the case of a ``"thermostat"`` type, the OPERATING_STATE attribute will be used (see below). It will default to a light gray color. If the PRIMARY_CONTROL attribute contains states that change the color, the color of the multi attribute tile will also change.
You may some code for Color Control bulbs that adjusts the Hue using some magic numbers and fun math.

This comment has been minimized.

@pennig

pennig May 23, 2016

Contributor

"You may see code…"?

This comment has been minimized.

@jimmyjames

jimmyjames May 23, 2016

Contributor

yep that makes more sense :)

``NEXT_TRACK`` Renders a control for going to the next track
``SLIDER_CONTROL`` Renders a control to select a volume level
``MEDIA_MUTED`` Allows the user to press the volume icon to mute
``MARQUEE`` Will display the currently playing track description below the ``PRIMARY_CONTROL``

This comment has been minimized.

@pennig

pennig May 23, 2016

Contributor

Add to marquee explanation: "Use newlines to delimit fields such as title, artist, album, etc."

Generic Multi-Attribute Tile
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If none of the predefined Multi-Attribute Tile types fit our needs, we can use the Generic Multi-Attribute Tile.

This comment has been minimized.

@pennig

pennig May 23, 2016

Contributor

s/our/your/

^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If none of the predefined Multi-Attribute Tile types fit our needs, we can use the Generic Multi-Attribute Tile.
The supported tile attribute types for the Generic Multi-Attribute Tile are shown in the following table:

This comment has been minimized.

@pennig

pennig May 23, 2016

Contributor

The table here doesn't actually render properly (i.e. at all). Not sure what's wrong...

@jimmyjames

This comment has been minimized.

Contributor

jimmyjames commented May 23, 2016

New commits made based on review feedback

@pennig

This comment has been minimized.

Contributor

pennig commented May 23, 2016

👍

@jimmyjames jimmyjames merged commit 327f203 into SmartThingsCommunity:master May 24, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment