Library . Xively . ReadWriteData . WriteDatastreamMetadata

Allows you to easily update the metadata of your datastream.

Input
• APIKey The API Key provided by Xively.
• DatastreamID The ID of the Datastream you would like to add metadata to. Required unless you are using CustomDatastreamData.
• FeedID The ID for the feed that you would like to update.
Optional Input
• CurrentValue The current value of the datastream. Leave empty to keep existing CurrentValue. Type "BLANK" to clear existing value.
• CustomDatastreamData Custom datastream formatted as a JSON array. See documentation for how to construct your own datastream feed. If custom DatastreamData is used, all other optional inputs are ignored.
• MaxValue The maximum value since the last reset. Leave empty to keep existing MaxValue. Type "BLANK" to clear existing value.
• MinValue The minimum value since the last reset. Leave empty to keep existing MinValue. Type "BLANK" to clear existing value.
• Tags Comma-separated list of searchable tags (the characters ', ", and commas are not allowed). Tags input overwrites previous tags, enter "BLANK" to clear all tags. Ex: "power,energy".
• Units The units of the datastream. Leave empty to keep existing Units. Type "BLANK" to clear existing Units. Ex: "Celsius".
• UnitSymbol The symbol of the Unit. Leave empty to keep existing UnitSymbol. Type "BLANK" to clear existing value. Ex: "C".
• UnitType The type of Unit. Leave empty to keep existing UnitType. Type "BLANK" to clear existing value. Ex: "basicSI".
Log in to Run Choreo
• Output
  Actuator Trigger Condition

  If{"ResponseStatusCode":{"type":"integer","description":"The response status code returned from Xively. For a successful datastream update, the code should be 200."},"Success":{"type":"boolean"}}ResponseStat...Success then write

  High Low

  to at

  • ResponseStatusCode The response status code returned from Xively. For a successful datastream update, the code should be 200.
• CHOREO CLASS

  • /*
    TembooTask class placeholder
    */

• iOS HEADER

  • /*
    TembooTask header placeholder
    */

• • Download editable code
  • Download compiled code
    Feature Preview pricing available soon

    Operate actuators & monitor sensors with Cloud Controls.

    Download compiled code.
    Learn more.

    Add a sensor or actuator to your board and download compiled code.
    Learn more.

    Upgrade to the Enterprise plan to get access to this premium feature.
    Learn more.

    This feature is not yet enabled for your microcontroller.
    Learn more.

    Gateway devices don't yet support Cloud Controls. Coming soon.

    Got It Upgrade Now
  • Commit to GitHub
  • Send to TI CCS Cloud

  OK! Let's set up your device

  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, 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 TI's CCS Cloud.

  You’ll be able to use 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 TI CCS Cloud IDE:

  TembooAccount.h

  instructions.txt

  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");
    
    WriteDatastreamMetadata writeDatastreamMetadataChoreo = new WriteDatastreamMetadata(session);
    
    // Get an InputSet object for the choreo
    WriteDatastreamMetadataInputSet writeDatastreamMetadataInputs = writeDatastreamMetadataChoreo.newInputSet();
    
    // Set inputs
    
    // Execute Choreo
    WriteDatastreamMetadataResultSet writeDatastreamMetadataResults = writeDatastreamMetadataChoreo.execute(writeDatastreamMetadataInputs);

• Header File

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

• Proxy Code

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

• Notes

  • This Choreo writes metadata to and/or creates/updates a single datastream in your Xively account.

    The documentation for this Xively resource can be found here.

    For most parameters you can leave the input empty to keep the previous settings (if any). If you add a value to an input it will overwrite the previous data. If you wish to clear out the data in the input variable enter "BLANK".

    You can also specify your own custom DatastreamData, which allows you to write your own JSON body for referencing multiple datastreams, etc. For the most custom or advanced options you can also create your own Feed in JSON or XML using the WriteData Choreo. Using an ID for a datastream that does not already exist will create a new datastream with that ID.

    The following is an example list of acceptable inputs:

    APIKey: {YOUR XIVELY API KEY}
    FeedID: {THE FEEDID YOU WISH TO UPDATE}
    DatastreamID: {THE DATASTREAMID YOU WISH TO UPDATE}
    Tags: energy,wind
    Units: BLANK (to erase unit value)
    UnitSymbol: F
    

    Here's an example of a custom JSON DatastreamData input (this will overwrite all other optional inputs in this Choreo):

    [
        {
            "id": "example",
            "current_value": "333"
        },
        {
            "id": "key",
            "current_value": "value"
        },
        {
            "id": "datastream",
            "current_value": "1337"
        }
    ]

    For a successful feed update, the ResponseStatusCode should be 200.