Logo

Conductor Documentation

  • Account
  • Application Tokens
  • Network Tokens
  • Downlink Modes
  • Downlink Mechanisms
  • Subscriptions
  • Asset Groups
  • Event Count
  • Changelog
    • v1.6.5a1
    • BugFixes
    • v1.6.4
    • Features
    • BugFixes
    • v1.6.4a10
    • BugFixes
    • v1.6.4a9
    • Features
    • v1.6.4a8
    • BugFixes
    • v1.6.4a6
    • BugFixes
    • v1.6.4a5
    • BugFixes
    • v1.6.4a4
    • BugFixes
    • v1.6.4a3
    • BugFixes
    • v1.6.4a2
    • BugFixes
    • v1.6.4a1
    • BugFixes
    • v1.6.3
    • Features
    • v1.6.3a12
    • Features
    • v1.6.3a11
    • Bug Fixes
    • v1.6.3a10
    • Features
    • Bug Fixes
    • v1.6.3a9
    • Features
    • Bug Fixes
    • v1.6.3a8
    • Bug Fixes
    • v1.6.3a7
    • Features
    • v1.6.3a6
    • Features
    • v1.6.3a5
    • Features
    • BugFixes
    • v1.6.3a5
    • Features
    • BugFixes
    • v1.6.3a4
    • BugFixes
    • v1.6.3a3
    • BugFixes
    • v1.6.3a2
    • Features
    • BugFixes
    • v1.6.3a1
    • BugFixes
    • v1.6.2
    • Features
    • Bug Fixes
    • v1.6.2a9
    • Bug Fixes
    • v1.6.2a8
    • Features
    • Bug Fixes
    • v1.6.2a7
    • Bug Fixes
    • v1.6.2a6
    • Bug Fixes
    • v1.6.2a5
    • Features
    • Bug Fixes
    • v1.6.2a4
    • Bug Fixes
    • v1.6.2a3
      • New Features
    • v1.6.2a2
      • Bug Fixes
    • v1.6.2a2
      • Changes
    • v1.6.2a1
      • New Features
    • v1.6.1
      • New Features
      • Bug Fixes
    • v1.6.0
      • New Features
    • v1.6.0b17
      • New Features
      • Fixes
    • v1.6.0b16
      • New Features
      • Fixes
    • v1.6.0b15
      • New Features
      • Fixes
    • v1.6.0b14
      • Fixes
    • v1.6.0b13
      • New Features
    • v1.6.0b12
      • New Features
    • v1.6.0b11
    • v1.6.0b10
    • v1.6.0b9
    • v1.6.0b8
      • New Features
    • v1.6.0b7
      • New Features
    • v1.6.0b6
      • Fixes
    • v1.6.0b5
      • New Features
    • v1.6.0b4
      • New Features
      • Fixes
    • v1.6.0b3
      • New Features
      • Fixes
    • v1.6.0b2
      • New Features
      • Fixes
    • v1.6.0b1
      • New Features
      • Fixes
    • v1.6.0a10
      • New Features
      • Fixes
    • v1.6.0a9
      • New Features
      • Fixes
      • Other Changes
    • v1.6.0a8
    • v1.6.0a7
      • Fixes
    • v1.6.0a6
      • Fixes
    • v1.6.0a5
      • New Features
      • Fixes
      • Other Changes
    • v1.6.0a4
      • New Features
      • Deprecated
      • Other Changes
    • v1.6.0a3
      • New Features
    • v1.6.0a2
      • New Features
      • Other Changes
    • v1.6.0a1
      • New Features
      • Other Changes
    • v1.5.4
      • New Features
    • v1.5.4b2
      • Fixed
    • v1.5.4b1
      • New Features
      • Fixed
    • v1.5.2
      • Fixed
    • v1.5.1
      • New Features
      • Other Changes
    • v1.5.0
      • Deprecated
      • Other Changes
    • v1.4.0
      • New Features

Conductor API Documentation

  • Conductor Package
    • Conductor Package
    • Account Module
    • Asset Group Module
    • Event Count Module
    • Subject Module
    • Subscriptions Module
    • Tokens Module
    • Util Module
  • Conductor Devices Package
    • Devices Package
    • Gateway Module
    • Module Module

Airfinder Documentation

  • Airfinder
  • User
  • Sites

Airfinder API Documenation

  • Airfinder Package
    • Airfinder Package
    • Area Module
    • Base Module
    • Site Module
    • User Module
    • Zone Module
  • Airfinder Devices Package
    • Devices Package
    • Access Point Module
    • Alert Tag Module
    • Node Module
    • Location Beacon Module
    • Supertag Module
    • tag Module
conductor-py
  • Downlink Modes
  • View page source

Downlink Modes

Devices do not form connections the same way you might expect other network devices to maintain connections. The Symphony Link Module for example will only establish a connection and will not communicate with the Gateway until it has a message to send or receive. The rules around receiving the DownlinkMessage are what define the Downlink Modes.

Mailbox Mode

When a Symphony Link Module or LTE CAT-M1 Module is in Mailbox Mode, the module does not constantly communicate with its associated gateway outside of initial connection. The module will just “Check its mailbox” at certain intervals. When a Mailbox Check occurs, the module can receive a “Pending” DownlinkMessage that the Gateway has in its Mailbox.

From a cloud perspective, sending a DownlinkMessage to a module in Mailbox Mode should include a time_to_live_s parameter in the Module.send_message() call

my_mod = account.get_module("$301$0-0-0-03000XXXX")
dl_msg = mod.send_message(b'hello world', time_to_live_s=300.0)

This time_to_live_s value represents the amount of time (in seconds) that the Mailbox Message can sit on the gateway’s Mailbox before that message “Expires”. If the module performs a Mailbox Check within the time_to_live_s of the message, since it was received by their gateway, then the module will receive that DownlinkMessage. Otherwise, if the module checks its Mailbox after the message’s time_to_live_s, the gateway will report no messages to downlink to the module.

Downlink Always On

This mode allows constant check-ins from the Symphony Link Module to the Gateway, allowing the fastest possible downlink to occur. This mode does not require any of the optional parameters of the Module.send_message(), however, they can be used when necessary.

Warning

The LTE CAT-M1 Module does not support Downlink Always On Mode.

Previous Next

© Copyright 2019, Thomas Steinholz, Allen Welkie, Scott Wohler.

Built with Sphinx using a theme provided by Read the Docs.