frodovdr
/
node-red
mirror of https://github.com/node-red/node-red.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Page: Node msg Conventions
Pages
API Reference Architecture Overview Architecture: Cluster Multi Process Contribution Process Dashboard layout tool Definitions Deprecated: Message properties overriding set node properties Design Notes Design: dynamic palette Design: API Token management Design: CLI tool to produce a node skeleton Design: Concurrent editing Design: Custom Node admin route handling Design: Dynamic MQTT node Design: Dynamic node's icon Design: Editable port labels Design: Editor Events Design: Editor Themes Design: Editor UI Customisation Design: Encryption of credentials Design: Enhancements to Split Join nodes Design: Flow Linter Design: Flow Manipulation API Design: Flow file format v2 Design: Function Library node Design: Library Sidebar Design: Logging Framework Design: Node Generator Design: Node Messaging API Design: Node blacklist whitelist function Design: Node module lifecycle Design: Node settings Design: Palette Management UI Design: Persistable Context Design: Platform Specific Nodes Design: Projects Design: Runnable Project Design: Runtime Editor Split Design: Runtime Events Design: Runtime extension points Design: Subflow Enhancements Design: Subflow Instance properties Design: Subflow Node modules Design: Usage telemetry Design: Using environment variables Design: Version Control Design: adminAuth User Management Design: external file for function and templates nodes Design: i18n de Design: i18n Design: msg.parts description of usage Design: multiuser Design: subflows vNext Design: subflows Design:Shared Global Context Editor Mouse Actions Editor Runtime API Flow Format Flow testing Home Input node feature definitions Live runtime information Node Design Guidelines Node documentation guide Node msg Conventions Output node feature definitions Pluggable Message Routing Query node feature definitions ReadMe Raspberry Pi Advanced Runtime Editor Comms protocol Technical Interchange 2018 04 13 Technical Interchange Meetings Testing UI testing Watch node feature definitions Web Nodes outline adminAuth Credential Authentication dynamic palette join in auto mode npm installable nodes
7 Node msg Conventions
zobalogh edited this page 2014-12-10 08:05:48 -08:00
Table of Contents

There are a few reserved properties within the structure of the msg objects being passed around in node-RED.

  • msg.payload - contains the main body of the message. For example, the text of a Tweet, the content of a webpage or a sensor reading.

  • msg.title - a title giving a good representation of what the message contains.

  • msg.description - a brief explanation of what data is contained within the message.

  • msg.data - some APIs provide large responses. For example, the Twitter api returns a huge object for each tweet containing many properties beyond just the text. This property can be used to store the original response - allowing access to all of the properties, not just those that get pulled out into msg.payload.

  • msg.location - an object containing properties representing location information.

    • msg.location.lat - Latitude
    • msg.location.lon - Longitude
    • msg.location.name - the name of a location
    • msg.location.city
    • msg.location.country

  • msg.time - a time. The time should be either JavaScript Date object, or a number of milliseconds since epoch.

For Fitness/activity based nodes/flows:

  • msg.payload.id - The ID of the activity in the given fitness system/API
  • msg.payload.type - The type of the activity, example: run/cycle ride
  • msg.payload.duration - Duration of the activity in seconds
  • msg.payload.distance - Distance of activity in metres
  • msg.payload.calories - Calories burned during activity in kilocalories
  • msg.payload.starttime - JavaScript Date object representing the start time of the activity