Difference between revisions of "Chumby Property Dictionary"
From Chumby Wiki
(→_chumby_music_source_state) |
|||
| Line 1: | Line 1: | ||
Under development: --[[User:Wayn3w|Wayn3w]] 20:45, 31 March 2008 (PDT) | Under development: --[[User:Wayn3w|Wayn3w]] 20:45, 31 March 2008 (PDT) | ||
| − | + | =_root= | |
The following are properties of _root explicitly set by the Chumby environment. | The following are properties of _root explicitly set by the Chumby environment. | ||
| + | ==_chumby_chumby_*== | ||
| + | ===_chumby_chumby_id=== | ||
| + | ===_chumby_chumby_name=== | ||
| + | |||
| + | ==_chumby_clock_*== | ||
| + | ===_chumby_clock_format=== | ||
| + | * valid values are 12 and 24 | ||
| + | |||
| + | ==_chumby_instance_*== | ||
| + | |||
===_chumby_instance_url=== | ===_chumby_instance_url=== | ||
* URL of service which the configuration widget uses to load and/or send widget parameters. The widget uses a different URL if it needs to send new parameter values; see [[#_chumby_widget_instance_href|_chumby_widget_instance_href]] | * URL of service which the configuration widget uses to load and/or send widget parameters. The widget uses a different URL if it needs to send new parameter values; see [[#_chumby_widget_instance_href|_chumby_widget_instance_href]] | ||
* See [[Data Persistence]] | * See [[Data Persistence]] | ||
| − | === | + | ==_chumby_music_source_*== |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
{| class="wikitable" style="text-align:left" border='1' cellspacing='0' cellpadding='2' | {| class="wikitable" style="text-align:left" border='1' cellspacing='0' cellpadding='2' | ||
|- bgcolor='lightgray' | |- bgcolor='lightgray' | ||
| Line 80: | Line 86: | ||
TBD: SlimServer | TBD: SlimServer | ||
| + | |||
| + | ===_chumby_music_source_state=== | ||
| + | * Only set when music is playing | ||
| + | * XML: Contains the properties of the current music selection. | ||
| + | * the name of the entity changes depending on the music source. | ||
===_chumby_music_source_label=== | ===_chumby_music_source_label=== | ||
| Line 91: | Line 102: | ||
===_chumby_music_source_selector=== | ===_chumby_music_source_selector=== | ||
* Only set when music is playing | * Only set when music is playing | ||
| + | |||
| + | ==_chumby_profile_*== | ||
| + | ===_chumby_profile_id=== | ||
| + | ===_chumby_profile_name=== | ||
| + | |||
| + | ==_chumby_timer_*== | ||
| + | ===_chumby_timer_expires=== | ||
| + | * -1 if the widget has been pinned via the control panel and it is passed expiration | ||
| + | |||
| + | |||
| + | ==_chumby_user_*== | ||
| + | ===_chumby_user_id=== | ||
| + | ===_chumby_user_name=== | ||
| + | |||
| + | ==_chumby_widget_*== | ||
===_chumby_widget_done=== | ===_chumby_widget_done=== | ||
* Cooperative mode; setting it to true signals the widget is done | * Cooperative mode; setting it to true signals the widget is done | ||
* See [[Developing_widgets_for_chumby#Cooperative_Mode|Cooperative Mode]] | * See [[Developing_widgets_for_chumby#Cooperative_Mode|Cooperative Mode]] | ||
| + | |||
| + | ===_chumby_widget_name=== | ||
| + | |||
| + | ==_chumby_widget_instance_*== | ||
| + | ===_chumby_widget_instance_count=== | ||
===_chumby_widget_instance_href=== | ===_chumby_widget_instance_href=== | ||
* URL of service which the widget uses to send widget parameters. The configuration widget uses a different URL if it needs to send new parameter values; see [[#_chumby_instance_url|_chumby_instance_url]] | * URL of service which the widget uses to send widget parameters. The configuration widget uses a different URL if it needs to send new parameter values; see [[#_chumby_instance_url|_chumby_instance_url]] | ||
* See [[Data Persistence]] | * See [[Data Persistence]] | ||
| + | |||
| + | ===_chumby_widget_instance_id=== | ||
| + | ===_chumby_widget_instance_index=== | ||
Revision as of 17:47, 9 April 2008
Under development: --Wayn3w 20:45, 31 March 2008 (PDT)
Contents
_root
The following are properties of _root explicitly set by the Chumby environment.
_chumby_chumby_*
_chumby_chumby_id
_chumby_chumby_name
_chumby_clock_*
_chumby_clock_format
- valid values are 12 and 24
_chumby_instance_*
_chumby_instance_url
- URL of service which the configuration widget uses to load and/or send widget parameters. The widget uses a different URL if it needs to send new parameter values; see _chumby_widget_instance_href
- See Data Persistence
_chumby_music_source_*
| _selector | _name | _state | _label |
|---|---|---|---|
| cbspodcasts | CBS Podcasts |
<item> <id>1</id> <name>Eye to Eye</name> <description>Hear newsmakers in their own words as Katie Couric picks the hottest interview of the day.</description> <url>http://www.cbsnews.com/common/includes/podcast/podcast_kceye_1.rss</url> <image_url>http://content.chumby.com/podcast/cbs/image/1</image_url> </item> |
Eye to Eye: Sadr City |
| chumbcast | Radio Free Chumby | <station channels="2" samplerate="44100" lc="1" ct="WERS - Emeerson College" genre="Independent" br="128" id="30" mt="audio/mpeg" name="WERS- Emerson College" /> | WERS - Emerson College |
| directurl | My Streams | <stream url="http://www.wbur.org/listen/feed/shoutcast.pls" id="a234a514-a483-4cd7-1869-46061aa805fc" mimetype="audio/x-scpls" name="WBUR" /> | WBUR |
| ipod | iPod |
<playlist id="1" trackcount="13" fullTrackCOunt="13"> <name>Bruce Springsteen</name> </playlist> |
Streets of Philadelpha |
| mediafly | Mediafly Podcasts | <channel slug="history and culture" name="history and culture" /> | US Job Losses; Dr King---s Dream; Primary News |
| mp3files | My Music Files | <mp3files/> | (an empty string) |
| nytpodcasts | New York Times Podcasts |
<item> <id>25</id> <name>Front Page</name> <description>James Barron summarizes the top headlines every weekday morning.<>Schedule: Mon - Fri</description> <url>http://www.nytimes.com/services/xml/rss/nyt/podcasts/frontpage.xml</url> <image_url>http://content.chumby.com/podcast/ny_times/image/25</image_url> </item> |
NYT Front Page for 04/05/2008 |
| shoutcast | Shoutcast | <station lc="4311" ct="Ulrich Schnauss - Never Be The Same" genre="Ambient Chill" br="128" id="841" mt="audio/mpeg" name="Groove Salad: a plate of ambient beats and grooves. [Soma FM]" /> | Groove Salad: a plate of ambient beats and grooves. [Soma FM] |
TBD: SlimServer
_chumby_music_source_state
- Only set when music is playing
- XML: Contains the properties of the current music selection.
- the name of the entity changes depending on the music source.
_chumby_music_source_label
- Only set when music is playing
- Contains the name of the current playing
_chumby_music_source_name
- Only set when music is playing
- The name of the music source, such as "Radio Free Chumby" or "Mediafly Podcasts."
_chumby_music_source_selector
- Only set when music is playing
_chumby_profile_*
_chumby_profile_id
_chumby_profile_name
_chumby_timer_*
_chumby_timer_expires
- -1 if the widget has been pinned via the control panel and it is passed expiration
_chumby_user_*
_chumby_user_id
_chumby_user_name
_chumby_widget_*
_chumby_widget_done
- Cooperative mode; setting it to true signals the widget is done
- See Cooperative Mode
_chumby_widget_name
_chumby_widget_instance_*
_chumby_widget_instance_count
_chumby_widget_instance_href
- URL of service which the widget uses to send widget parameters. The configuration widget uses a different URL if it needs to send new parameter values; see _chumby_instance_url
- See Data Persistence
