Ubiworx User Documentation

Introduction

• What is ubiworx
• Getting Started
  • 1. Register for an account
  • 2. Install ubiworx
  • 3. Start using ubiworx

ubiworx web interface

• ubiworx broker web interface
  • Introduction
  • Create an account and login
• Gateway configuration
  • Gateway dashboard
  • Add a new gateway
  • Edit gateway
  • Clone gateway
• Install ubiworx on your gateway
  • Prerequisites
  • Setup new UP board gateway
  • Setup new raspberry pi gateway
  • Setup new intel edison gateway
• Sensors configuration
  • Sensors dashboard
  • Add a new sensor or actuator
  • Edit sensor
  • Clone sensor
  • Sync sensors
• Create logic diagram
  • The local logic screen
  • Block diagrams rules
  • The tag block
  • A simple example
• Alarms
  • Ubiworx alarm system
  • Alarms panel usage

APPENDIX

• Gateway parameters List
  • General information
  • Configuration parameters
• Sensor general parameters list
  • General information
  • Range
  • Data sampling
  • Configuration parameters
• Logic block list
  • Sink / source block summary
  • Input blocks
    • Tag block
    • Remote sensor block
    • Constant
    • SampleDB input block
    • SampleDB-since input block
    • Schedule block
  • Output
    • Tag block
    • Remote actuator block
  • SampleDB output block
    • Alarm block
  • Arithmetic, boolean and comparative blocks
  • Timing blocks
  • Aggregation and conditioning blocks
  • Average block implementation
  • Lua block
  • Switch block
• Available sensors and actuators
  • ADAM4055
  • ADXL345
    • Tags updated by this sensor:
  • ADXL345 (Edison)
    • Default properties:
  • BMF136
  • BMF136 Data
    • Default properties:
  • BME280
    • Tags updated by this sensor:
  • Carlo Gavazzi em21
    • Tags updated by this sensor:
  • CoAp sensor
  • CoAp actuator
  • Core temp (Edison)
    • Default properties:
  • Core temp (Galileo)
    • Default properties:
  • CPU free
    • Default properties:
  • MCP4725 I2C DAC
  • DISK free
    • Default properties:
  • ESP3 receiver
  • ESP3 input
  • ESP3 node
  • SM6 Geophone
    • Tags updated by this sensor:
  • GPI
  • GPI (Edison)
  • GPO
  • GPO (Edison)
  • GPS Janus
  • GPS Janus 3G
  • Home easy PIR 1
  • Home easy PIR 2
  • IIO ADC
    • Default properties:
  • IIO ADC (Edison)
    • Default properties:
  • IIO ADC PiPlus
    • Default properties:
  • IIO digital
  • Kankun plug
  • Key barrel
  • LCD RGB UP
  • LED Supermicro
  • Light wave rf socket
  • LM Sensor
    • Default properties:
  • Local actuator
  • Local asynchronous sensor
  • Local sensor
    • Default properties:
  • Memory free
    • Default properties:
  • Network failover
  • 1-Wire temperature
    • Default properties:
  • Oregon rain
  • Oregon wind
  • Papouch TQS3 modbus
    • Default properties:
  • Papouch TQS3 modbus TCP
    • Default properties:
  • PWM (Edison)
  • PWM (Supermicro)
  • Rayleigh smart meter (ModBus RTU)
    • Default properties:
  • Rayleigh smart meter (ModBus TCP)
    • Default properties:
  • RFID
  • RFXCOM
  • Serial 16x2 LCD display
  • Serial temperature sensor
    • Default properties:
  • Sound level
    • Tags updated by this sensor:
  • SSP cash acceptance
  • SSP cash accepted
  • SSP cash acceptor status
    • Default properties:
  • SSP cash dispensed
  • SSP cash dispenser
  • SSP errors
  • SSP item dispensed
  • SSP item dispenser
  • SSP motor running
    • Default properties:
  • SSP status
  • SunGrow Inverter (ModBus TCP)
    • Default properties:
  • THGR810
  • TOSR0X relay board
  • TOSR0X relay board XBee
  • VCNL4010
    • Default properties:
  • VCNL4010 (Edison)
    • Default properties:
  • WiFi signal
    • Default properties:
  • XBee
  • XBee ADC
  • XBee GPI
  • XBee GPO
  • XBee node

• RESTful cloud API methods
  • Environment variables
  • Gateways
  • Gateways configuration
  • Sync gateway changes.
  • Sensors
  • Historical sensor data
  • Get and Set live data
  • Alarms
  • Alarm events
  • Use case