Module: Log Reader

From Yombo
Jump to: navigation, search
Quick Facts
Links
Documentation
Repository
Issue tracker
Module Details
Created 2018-01-08 20:44:39 GMT
Developer Details
Prod Branch master
Prod Updated 2018-10-26 08:16:37
Prod Version None
Dev Branch develop
Dev Updated 2016-12-18 12:49:47
Dev Version None

Summary

This module extends the capabilities of the Yombo Gateway by adding the ability to monitor a text file for device commands.

Usage

The primary purpose of this module is to demonstrate creating modules and using the Yombo Filereader utility. The Filereader) utility allows for easily monitoring a file for updates and support file skip-ahead when the gateway restarts.

With this module, you can simple echo in a command to be peformed:

echo "bathroom light on" >> monitored_file.txt

This is useful if you want basic scripts or other utilities to control automation devices.

Warning: Be sure to grant write access only to users and applications that should be able to send commands.

The actual commands are processed by the YomboBot module and is required.

Installation

Simply mark this module as being used by the gateway, and the gateway will download and install this module automatically.

Requirements

YomboBot module is required for parsing the commands.

License

The Yombo team and other contributors hopes that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See Yombo Gateway LICENSE file for full details.


This page was last edited on 26 October 2018.