KNoT Logo
  • Introduction
    • Why KNoT?
    • Features
      • Avoid reinventing the wheel
      • Open source
      • Distributed cloud
      • Semantic data model
      • Space-time data sharing
      • From prototype to product
    • Architecture
  • Quick Start Guide
    • Configuring the KNoT Gateway
      • Flashing the KNoT Gateway
      • Adding Gateway to KNoT Cloud
    • Thing’s Development Environment
    • Programming the KNoT Thing
      • Compiling project
      • Flashing board
    • Configuring the Thing network
    • See connected Things
    • Representing an Application on KNoT Cloud
    • Interacting with an Application through KNoT Cloud SDK
  • KNoT Cloud
    • Introduction
      • What is KNoT Cloud?
      • Features
        • Distributed Messaging
        • Data Storage
        • Incorporated Protocol
      • Architecture
    • Deploy
      • Installation and usage
        • Download
      • Development only preparation
        • Build and install CLI tool
      • Choose the stack
        • Development
        • Production
      • Initialize Swarm mode
      • Configure DNS
      • Deploy: stage 1
        • Configure services
        • Deploy
        • Verify
      • Deploy: stage 2 bootstrap
        • Deploy
        • Bootstrap
        • Tear down
      • Deploy: stage 2
        • Configure services
        • Configure mail service
        • Configure reset address
        • Deploy
        • Access
    • API Reference
      • WebSocket SDK
        • Quick Start
        • Methods
        • Events
      • Authenticator SDK
        • Quick Start
        • Methods
      • Storage SDK
        • Quick Start
        • Methods
  • KNoT Gateway
    • Hardware Architecture
    • Software Architecture
  • KNoT Thing
    • Requirements
      • Linux based OS
      • Zephyr
        • Update Your Operating System
        • Install Requirements and Dependencies
        • Install the Zephyr SDK
        • Set up the Zephyr Environment
      • nRF5x Command Line Tools and Segger JLink
      • Set up the KNoT SDK Environment
      • Add support to the KNoT command line interface
      • Add USB access to your user
      • Apply changes to profile
    • Using CLI
      • Set default target board
      • Set external OpenThread path
      • Clear project and building
      • Compile for your target board
      • Use an external DTS overlay file
      • Flash board when done
      • Flash bootloader
      • Other commands
    • Using Docker
      • Building image
      • Running the container
      • Compile for your target board
      • Flashing
        • Using nRF Connect
        • Using KNoT CLI on Linux
      • Using other knot commands
    • Create an Application
      • CMakeLists.txt
      • prj.conf
      • setup.conf
      • <board>.overlay (optional)
      • src/<app-name>.c
    • Samples
      • Basic Samples
        • blink
        • button
        • multisensor
        • plate
        • tank
        • thermo
        • toggle
      • Sensor Samples
        • analog-alert
        • digital-counter
    • API Reference
      • setup() & loop()
      • Data
      • knot_data_register()
      • knot_data_config()
      • knot_callback_t
    • Supported Boards
      • KNoT Dongle
        • Overview
        • Supported Features
        • Connections and IOs
        • Flash instructions
        • Suggested examples
      • KNoT DK
        • Overview
        • Supported Features
        • Connections and IOs
        • Flash instructions
        • Suggested examples
  • KNoT Setup App
    • Features
      • Device configuration
      • The device’s list
      • Find the gateways
      • Bluetooth Device
  • Source Code
    • KNoT Gateway
    • KNoT Thing
    • KNoT Cloud
    • KNoT Setup App
    • KNoT Hardware
  • Releases
  • Contact
KNoT
  • Docs »
  • KNoT Cloud »
  • API Reference

API Reference¶

The knot-cloud-sdk-js is a client side library for Node.js and browser that aims to help developers to create solutions with the KNoT Cloud.

This library exports the following SDKs:

  • WebSocket SDK
    • Quick Start
      • Install
      • Run
    • Methods
      • constructor(options)
      • connect()
      • close()
      • register(properties)
        • Result
      • unregister(id)
      • getDevices(query)
        • Result
      • createSessionToken(id)
        • Result
      • revokeSessionToken(id, token)
      • updateSchema(schema)
      • activate(id)
      • updateMetadata(id, metadata)
      • publishData(sensorId, value)
      • getData(id, sensorIds)
      • setData(id, data)
      • on(name, handler)
    • Events
      • Event: “registered”
      • Event: “unregistered”
      • Event: “data”
      • Event: “command”
  • Authenticator SDK
    • Quick Start
      • Install
      • Run
    • Methods
      • constructor(options)
      • createUser(email, password)
      • authUser(email, password)
      • forgotPassword(email)
      • resetPassword(email, token, newPassword)
  • Storage SDK
    • Quick Start
      • Install
      • Run
    • Methods
      • constructor(options)
      • listData(query)
      • listDataByDevice(id, query)
      • listDataBySensor(deviceId, sensorId, query)
Next Previous

© Copyright 2019, CESAR