sharc-support

Sharc hardware, firmware, and software related support and discussions.

Links

Data Sheet

Setup Instructions

Cloud Sharc Studio

iOS Sharc Studio

MQTT Namespace

MQTT EVENTS

Topic structure: sharc/{{sharc_id}}/evt/{{name}}

MQTT Connect

Availability, published upon connection.

Topic: sharc/{{sharc_id}}/evt/avail
Retain: true
Payload:

{
  "seq": 0,
  "v": true
}

MQTT Disconnect

Device disconnect message is published by MQTT broker LWT mechanism.

Topic: sharc/{{sharc_id}}/evt/avail
Retain: true
Payload:

{
  "seq": -1,
  "v": false
}

Boot Counter

Reboot causes and counters, published upon connection.

Topic: sharc/{{sharc_id}}/evt/rc
Retain: true
Payload:

{
  "seq": 1,
  "v": {
    "power_on": 0,
    "hard_reset": 0,
    "watchdog_reset": 0,
    "deep_sleep": 0,
    "soft_reset": 0
  }
}

$.v.power_on - [int] Power_On count.
$.v.hard_reset - [int] Hard count.
$.v.watchdog_reset - [int] WDT count.
$.v.deep_sleep - [int] Deep_Sleep count.
$.v.soft_reset - [int] Soft count.

Network Interface

Current network interface values, published upon connection.

Topic: sharc/{{sharc_id}}/evt/net
Retain: true
Payload:

{
  "seq": 1,
  "v": {
    "type": "WLAN",
    "static": false,
    "ip": "0.0.0.0",
    "gw": "0.0.0.0",
    "mask": "0.0.0.0",
    "dns": "0.0.0.0",
    "mac": "deadbeef",
    "quality": 100,
    "ssid": "wifi-name",
    "lan_fallback_s": 120
  }
}

$.v.type - [string] Current network type of WLAN or LAN.
$.v.static - [bool] Whether the IP configuration is static or dynamic.
$.v.ip - [string] Device IP Address.
$.v.gw - [string] Gateway IP Address.
$.v.mask - [string] Subnet mask.
$.v.dns - [string] DNS Server IP Address.
$.v.mac - [string] Device Hardware Address.
$.v.quality - [int] Connection quality.
$.v.ssid - [string] (WLAN only) Wifi network name.
$.v.lan_fallback - [int] (WLAN only) Seconds to wait for Wifi connection before rebooting into LAN. Zero to disable this feature.

Device Information

Device information, published upon connection.

Topic: sharc/{{sharc_id}}/evt/ver
Retain: true
Payload:

{
  "seq": 1,
  "v": {
    "mfg": "MRIIOT",
    "model": "SHARC",
    "serial": "{chip-id}",
    "hw": "105",
    "fw": "{git-head}",
    "sw": "RTM/FROZEN"
  }
}

$.v.mfg - [string] Hardware manufacturer.
$.v.model - [string] Hardware model.
$.v.serial - [string] Hardware serial number.
$.v.hw - [string] Hardware version.
$.v.fw - [string] Firmware version.
$.v.sw - [string] Software version.

MQTT Information

MQTT connection information, published upon connection.

Topic: sharc/{{sharc_id}}/evt/mqtt
Retain: true
Payload:

{
  "seq": 1,
  "v": {
    "address": "192.168.5.5",
    "port": 1883,
    "user": "",
    "anonymous": true
  }
}

$.v.address - [string] Broker address.
$.v.port - [int] Broker port.
$.v.user - [string] Username.
$.v.anonymous - [bool] Is connection anonymous.

Sensor Values

Values read from sensors.

Settings and their effects:

sensor.aggregate:
- true: all sensors published on a single topic, packed into a single JSON object.
- false: each sensor published on its own topic.
sensor.calibrate:
- true: each sensor's calibrate property is evaluated before publishing.
- false: evaluation of calibrate property is omitted.
sensor.convert:
- true: each sensor's convert property is evaluated before publishing.
- false: evaluation of convert property is omitted.

Mode: Aggregate

Setting: sensor.aggregate = true and sensor.calibrate = false|true and sensor.convert = false.
Description: All sensors published on a single topic, uncalibrated and unconverted values.
Topic: sharc/{{sharc_id}}/evt/io
Retain: false
Payload:

{
  "seq": 1,
  "v": {
    "s0": 0,
    "s1": 0,
    "s2": 0,
    "s3": 0
  }
}

$.v.s0 - [int] PNP sensor state.
   0 - off
   1 - on
$.v.s1 - [int] NPN sensor state.
   0 - off
   1 - on
$.v.s2 - [decimal] Voltage sensor value.
   0 - minimum bits
   32767 - maximum bits
$.v.s3 - [decimal] Ampere sensor value.
   0 - minimum bits
   32767 - maximum bits

Mode: Distinct

Setting: sensor.aggregate = false and sensor.calibrate = false and sensor.convert = false.
Description: Each sensor published on its own topic, uncalibrated and unconverted values.
Topic: sharc/{{sharc_id}}/evt/io/{{sensor_name}}
Retain: false
Payload:

{
  "seq": 1,
  "v": 0
}

Mode: Aggregate-Calibrated-Converted

Setting: sensor.aggregate = true and sensor.calibrate = true and sensor.convert = true.
Description: All sensors published to a single topic, calibrated and converted values. Units defined in RFC8428.
Topic: sharc/{{sharc_id}}/evt/io
Retain: false
Payload:

{
  "seq": 1,
  "v": {
    "s0": {
      "v": 0.0,
      "u": "/"
    },
    "s1": {
      "v": 1.0,
      "u": "/"
    },
    "s2": {
      "v": 10,
      "u": "V"
    },
    "s3": {
      "v": 100,
      "u": "Cel"
    }
  }
}

$.v.s0 - [any] PNP sensor.

v - value
u - units
$.v.s1 - [any] NPN sensor state.

v - value
u - units
$.v.s2 - [any] Voltage sensor value.

v - value
u - units
$.v.s3 - [any] Ampere sensor value.

v - value
u - units

Command Acknowledgement

Acknowledgement of command execution.

Topic: sharc/{{sharc_id}}/evt/ack
Retain: false
Payload:

{
  "seq": 1,
  "v": {
    "id": "abc123",
    "rc": 0
  }
}

$.v.id - [string] Correlation to command.
$.v.rc - [int] Command execution result code.
0 - success
non-zero - failure code

User Data

Data published from user script.

Topic: sharc/{{sharc_id}}/evt/user
Retain: false
Payload:

{
  "seq": 1,
  "v": {
    "user": "object"
  }
}

$.v - [any] User data.

MQTT COMMANDS

Topic structure: sharc/{{sharc_id}}/cmd/{{name}}

Each command payload must include a unique id attribute.
This value is published back as an acknowledgement of command execution status.
Commands with the id attribute are dropped.

Actions