Skip to content
Mike Blackstock edited this page Jul 30, 2017 · 45 revisions

To help co-ordinate content for the cookbook, this wiki will be used to track topics we want to cover.

If you want to contribute a recipe to the cookbook:

  1. check the list here for topics we want to cover.
  2. have a read of the style guide
  3. clone the repository, add your recipe and send us a pull request

If you want to discuss any aspect, come join us in the #docs channel on slack.

Topics in italics are high-level themes and may need breaking down into multiple recipes.

HTTP endpoints

HTTP requests

MQTT

  • MQTT Basics
  • Connect to an MQTT broker
  • Publish messages to a topic
  • Set the topic of a published message
  • Publish a retained message to a topic
  • Subscribe to a topic
  • Receive a parsed JSON message

WebSockets

  • Create a websocket listener endpoint
  • Send and receive messages using websocket listener
  • Connect to an websocket endpoint as a client
  • Send and receive messages to websocket client endpoint

TCP/UDP

Logic/Flow Control

  • branching a flow
  • looping
  • watchdog - trigger
  • report by exception

State machines

Functions

Suggest section for functions where we provide simple info on Javascript, how to use the APIs available for function nodes based on Writing Functions.

  • Generate a new message using Javascript
  • Send data to multiple outputs
  • see Writing Functions
  • Access different parts of a msg object (see here for examples)
  • Calculate a result using messages from two different inputs

Error handling

  • catch an error
  • retry an action after an error

Storage

  • Write data to a local file
  • Read data from a local file
  • for all X in dbs
  • insert data into db X
  • query data from db X
  • Collect data in memory temporarily
  • Collect data and periodically save in a database
  • How to use the storage plugin to save flows to a database
  • How to backup flows and related configuration

Raspberry Pi

Configuration

Dashboard

Logging

Security