Library . Fitbit . Sleep . GetSleep

Gets a summary and list of a user's sleep log entries for a specified date.

Input
• AccessToken The Access Token retrieved during the OAuth process.
• Date The date that corresponds with the log entry you want to retrieve (in the format yyyy-MM-dd).
Optional Input
• ResponseFormat The format that you want the response to be in: xml or json. Defaults to json.
• UserID The user's encoded id. Defaults to "-" (dash) which will return data for the user associated with the token credentials provided.
Log In To Run
• Output
  Actuator Trigger Condition

  If{"Response":{"type":"","description":"The response from Fitbit."},"TotalMinutesAsleep":{"type":"decimal","description":"The total number of minutes asleep."},"TotalSleepRecords":{"type":"integer","description":"The total number of sleep records."},"TotalTimeInBed":{"type":"decimal","description":"The summarized total for time in bed."},"Success":{"type":"boolean"}}ResponseTotalMinutes...TotalSleepRe...TotalTimeInB...Success then write

  High Low

  to at

  • Response The response from Fitbit.
  • TotalMinutesAsleep The total number of minutes asleep.
  • TotalSleepRecords The total number of sleep records.
  • TotalTimeInBed The summarized total for time in bed.
• CHOREO CLASS

  • /*
    TembooTask class placeholder
    */

• iOS HEADER

  • /*
    TembooTask header placeholder
    */

• • Simple
  Enhanced
  Add a sensor via the virtual pin board above to generate code for sensor data graphs.
  Compiled
  Add a sensor or actuator via the virtual pin board above to generate compiled code for sensor data graphs and remote actuator control.
  Device Configure Changed

  Since you've changed your device configuration, you'll need to tell us about this new device.

  Update Device
  1. Add a sensor or actuator to your device.
  2. Register your board and download your code.

  Download
  • Download editable code
  • Commit to GitHub
  • Send to CCS Cloud

  OK! Let's set up your device

  This feature is in experimental mode - pricing coming soon.

  Device Name *

  Device ID

  Description

  Location *

  Use lat/long

  Sensor Data
  Frequency *

  Pro Tip!

  Power consumption will increase if you choose a higher frequency.

  Every 30 seconds Every minute Every 5 minutes Every 30 minutes Every hour Every day Custom interval

  Safeguard data

  what's this?

  If connectivity is lost, up to 2MB of data will be stored locally on your device, and updated when connectivity is restored.

  + new tag

  Save
  Commit your generated code
  and collaborate with others.

  Send your code straight to a GitHub repository.

  Collaborating on GitHub?

  Your code will be visible by others in your repos. Keep credentials private by saving a Profile or commit code with Placeholder inputs.

  Choose a GitHub Repository

  Name:

  The following files will be added to this repo:

  * Don't worry! Your credentials and any inputs that aren't saved in a Profile will not be included.

  Success!

  Visit the link below to view, modify, and share code.

  Cancel Commit code to GitHub Use Placeholders Save a Profile Commit Close
  Send code to CCS Cloud.

  You'll be able to edit and share your code from TI's CCS Cloud IDE.

  Name your application

  Names can only contain letters, numbers, hyphens, and underscores.

  The following will be sent to CCS Cloud:

  TembooMain.c

  TembooAccount.h

  instructions.txt

  + 9 others

  Success!

  Visit the link below to view, modify, and share code.

  https://dev.ti.com/ide/

  Cancel Send to CCS Cloud Send Close
  Code

  • // Instantiate the Choreo, using a previously instantiated TembooSession object, eg:
    // TembooSession session = new TembooSession("accountName", "myFirstApp", "abc123xxxxxxxxxxxxxx");
    
    GetSleep getSleepChoreo = new GetSleep(session);
    
    // Get an InputSet object for the choreo
    GetSleepInputSet getSleepInputs = getSleepChoreo.newInputSet();
    
    // Set inputs
    
    // Execute Choreo
    GetSleepResultSet getSleepResults = getSleepChoreo.execute(getSleepInputs);

• Header File

  • /* 
    A header file containing your Temboo account information will appear here once you've
    configured your device above.
    */

• Proxy Code

  • /*
    Please log in to generate proxy server code for use with the JavaScript SDK.
    */

• Notes

  • This Choreo uses your OAuth credentials to authenticate your account with Fitbit, and retrieves a list of a user's sleep log entries for a specified date. The documentation for this Fitbit resource can be found here.

    Here's an example list of acceptable inputs:

    ConsumerKey: {YOUR FITBIT CONSUMER KEY}
    ConsumerSecret: {YOUR FITBIT CONSUMER SECRET}
    AccessToken: {YOUR FITBIT ACCESS TOKEN}
    AccessTokenSecret: {YOUR FITBIT TOKEN SECRET}
    Date: 2013-03-18

    The following is a sample of the JSON information returned by this Choreo:

    {
        "sleep": [
            {
                "isMainSleep": true,
                "logId": 29744,
                "efficiency": 98,
                "startTime": "2011-06-16T00:00:00.000",
                "duration": 28800000,
                "minutesToFallAsleep": 0,
                "minutesAsleep": 480,
                "minutesAwake": 0,
                "minutesAfterWakeup": 0,
                "awakeningsCount": 0,
                "timeInBed": 480,
                "minuteData": [
                    {
                        "dateTime": "00:00:00",
                        "value": "3"
                    },
                    {
                        "dateTime": "00:01:00",
                        "value": "2"
                    },
                    {
                        "dateTime": "00:02:00",
                        "value": "1"
                    }
                ]
            },
            {
                "isMainSleep": false,
                "logId": 29745,
                "efficiency": 93,
                "startTime": "2011-06-16T14:00:00.000",
                "duration": 3600000,
                "minutesToFallAsleep": 20,
                "minutesAsleep": 38,
                "minutesAwake": 0,
                "minutesAfterWakeup": 2,
                "awakeningsCount": 0,
                "timeInBed": 60,
                "minuteData": [
                    {
                        "dateTime": "14:00:00",
                        "value": "3"
                    }
                ]
            }
        ],
        "summary": {
            "totalMinutesAsleep": 518,
            "totalSleepRecords": 2,
            "totalTimeInBed": 540
        }
    }