update esppilight lib

content of the library is not filtered on 433mhz only
This commit is contained in:
Florian committed 2018-11-28 20:41:37 +01:00
1 parent a275e48ee1
commit 67dd7ac078
1030 files changed
+203335 -116

No files matched your search

@@ -0,0 +1,83 @@
===============
pilight-control
===============
Control pilight devices
-----------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-control`` --device DEVICE --state STATE
| ``pilight-control`` [OPTION]... --device DEVICE --values VALUES
| ``pilight-control`` [--server SERVER] [ --port PORT] [OPTION]... --device DEVICE
DESCRIPTION
===========
``pilight-control`` is a tool to control a device configured in a pilight daemon configuration. It supports switching the state and/or modifying other values (such as dimlevel, temperature, or humidity) of the device.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
|
| ``-S``, ``--server=x.x.x.x``
| Connect to a pilight daemon at this address. Requires -P
|
| ``-P``, ``--port=xxxx``
| Connect to a pilight daemon at this port. Requires -S
|
| ``-C``, ``--config=PATH_TO_CONFIG``
| Path to configuration file
|
| ``-d``, ``--device=DEVICE_NAME``
| Name of the configured device to be controlled
|
| ``-s``, ``--state=STATE``
| State to switch DEVICE to
|
| ``-v``, ``--values=VALUES``
| Supply other values for DEVICE, such as dimlevel=10
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-daemon``
| ``pilight-debug``
| ``pilight-flash``
| ``pilight-raw``
| ``pilight-receive``
| ``pilight-send``
| ``pilight-sha256``
| ``pilight-uuid``
@@ -0,0 +1,98 @@
==============
pilight-daemon
==============
The pilight daemon
------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-daemon``
| ``pilight-daemon`` [OPTION]...
| ``pilight-daemon`` [--server SERVER] [ --port PORT] [OPTION]...
DESCRIPTION
===========
``pilight-daemon`` is the main software of the pilight project. It is responsible for handling and interpreting received signals, as well as generating signals to communicate with and control various devices.
A configuration file is required. By default, ``/etc/pilight/config.json`` is used. Configuration files are written in the JSON format.
Consult the pilight manual <https://manual.pilight.org/> for details on how to configure and use pilight.
By default, the pilight daemon hosts a webgui which allows controlling devices through a clickable interface in a webbrowser. The pilight daemon runs a socket server and provides a REST API to interface with the pilight daemon.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
|
| ``-C``, ``--config=PATH_TO_CONFIG``
| Specify to use configuration file at PATH rather than standard configuration
|
| ``-S``, ``--server=x.x.x.x``
| Connect to a pilight daemon at this address. Requires -P
|
| ``-P``, ``--port=xxxx``
| Connect to a pilight daemon at this port. Requires -S
|
| ``-F``, ``--foreground``
| Do not daemonize
|
| ``-D``, ``--debug``
| Do not daemonize and print more debug information
Debugging options:
|
| ``--stacktracer``
| Show internal function calls
|
| ``--threadprofiler``
| Show per thread CPU usage
|
| ``--debuglevel``
| Show additional development information
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-control``
| ``pilight-debug``
| ``pilight-flash``
| ``pilight-raw``
| ``pilight-receive``
| ``pilight-send``
| ``pilight-sha256``
| ``pilight-uuid``
@@ -0,0 +1,71 @@
=============
pilight-debug
=============
Decode incoming raw streams into logical pulsetrains
----------------------------------------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-debug``
| ``pilight-debug`` [OPTION]
DESCRIPTION
===========
``pilight-debug`` is a tool to decode incoming raw streams into logical pulsetrains. It also prints certain calculated parameters of the caught pulsetrain.
Prints data to STDOUT until interrupted with ^C.
This tool requires root privileges.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
|
| ``-C``, ``--config=PATH_TO_CONFIG``
| Path to configuration file
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-control``
| ``pilight-daemon``
| ``pilight-flash``
| ``pilight-raw``
| ``pilight-receive``
| ``pilight-send``
| ``pilight-sha256``
| ``pilight-uuid``
@@ -0,0 +1,79 @@
=============
pilight-flash
=============
Flash hardware with pilight firmware
------------------------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-flash`` --file FIRMWARE_FILE
| ``pilight-flash`` [OPTION]... --file FIRMWARE_FILE
DESCRIPTION
===========
``pilight-flash`` is a tool to flash pilight firmware to ATMel chips (such as the ATTiny and ATMega).
The pilight ATMel firmware pre-filters streams and prevents noise from reaching the pilight daemon. This
lowers the CPU usage of the pilight daemon greatly, because the pilight daemon will not continuously
attempt to interpret noise as valid protocols. Currently supported chips are the ATTiny25, ATTiny45,
ATTiny85, and ATMega328P.
Besides acting as a pre-filter, the firmware also allows using pilight with senders and receivers on non
GPIO-capable hardware (such as most desktops, servers, etc.) The flashed ATMega chip is connected via USB,
and the sender and receiver are wired to the GPIO pins on the chip. Consult the pilight manual <https://manual.pilight.org/> for wiring schematics.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
|
| ``-C``, ``--config=PATH_TO_CONFIG``
| Path to configuration file
|
| ``-f``, ``--file=PATH_TO_FIRMWARE``
| Firmware file to flashed
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-control``
| ``pilight-daemon``
| ``pilight-debug``
| ``pilight-raw``
| ``pilight-receive``
| ``pilight-send``
| ``pilight-sha256``
| ``pilight-uuid``
@@ -0,0 +1,15 @@
Programs
========
.. toctree::
:maxdepth: 1
control
daemon
debug
flash
raw
receive
send
sha256
uuid
@@ -0,0 +1,74 @@
===========
pilight-raw
===========
Print received raw streams
--------------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-raw``
| ``pilight-raw`` [OPTION]...
DESCRIPTION
===========
``pilight-raw`` is a tool to print raw streams as they are picked up by the receiver hardware.
Prints data to STDOUT until interrupted with ^C.
This tool requires root privileges.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
|
| ``-C``, ``--config=PATH_TO_CONFIG``
| Path to configuration file
|
| ``-L``, ``--linefeed``
| Structure raw printout with newlines between (probably) separate pulsetrains.
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-control``
| ``pilight-daemon``
| ``pilight-debug``
| ``pilight-flash``
| ``pilight-receive``
| ``pilight-send``
| ``pilight-sha256``
| ``pilight-uuid``
@@ -0,0 +1,84 @@
===============
pilight-receive
===============
Show datagrams received and transmitted by pilight
--------------------------------------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-receive``
| ``pilight-receive`` [OPTION]...
| ``pilight-receive`` [--server SERVER] [ --port PORT] [OPTION]... --device DEVICE
DESCRIPTION
===========
``pilight-receive`` is a tool to show all data that is sent and received by a pilight daemon instance or a pilight adhoc network. All data is shown as-is in JSON format.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
|
| ``-S``, ``--server=x.x.x.x``
| Connect to a pilight daemon at this address. Requires -P
|
| ``-P``, ``--port=xxxx``
| Connect to a pilight daemon at this port. Requires -S
|
| ``-s``, ``--stats``
| show CPU and RAM statistics in output
|
| ``-F``, ``--filter=PROTOCOL(S)``
| Specify protocols that should not be printed in the
| output stream. This is useful when trying to find
| IDs of devices such as weather stations or remote
| controls, but certain protocols are spamming the
| output. For example, datetime protocol data is
| transmitted every second, and is likely to displace
| useful information in the output stream. It can
| then be hidden with --filter=datetime
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-control``
| ``pilight-daemon``
| ``pilight-debug``
| ``pilight-flash``
| ``pilight-raw``
| ``pilight-send``
| ``pilight-sha256``
| ``pilight-uuid``
@@ -0,0 +1,160 @@
============
pilight-send
============
Send data to a pilight daemon
-----------------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-send`` --protocol PROTOCOL [OPTION]...
| ``pilight-send`` [--server SERVER] [ --port PORT] --protocol PROTOCOL [OPTION]...
DESCRIPTION
===========
``pilight-send`` is a tool to send data to a pilight daemon instance. It is a more versatile tool than ``pilight-control``, because it does not require the device to be previously configured.
It can be used to send signals for any pilight protocol that supports sending.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
|
| ``-p``, ``--protocol=PROTOCOL``
| Protocol to be sent
|
| ``-S``, ``--server=x.x.x.x``
| Connect to a pilight daemon at this address. Requires -P
|
| ``-P``, ``--port=xxxx``
| Connect to a pilight daemon at this port. Requires -S
|
| ``-C``, ``--config=PATH_TO_CONFIG``
| Path to configuration file
|
| ``-U``, ``--uuid=UUID``
| UUID to identify as when connecting to the pilight daemon
Further options are required, depending on the chosen protocol. Use ``pilight-send`` ``-p`` PROTOCOL ``--help`` to find which options are required for the protocol. Some long options differ between protocols. Protocol options include:
|
| ``-a``, ``--all``, ``--id=ALL``
| Send command to all devices with the same ID
|
| ``-a``, ``--api=API_KEY``
| Update a Weather Underground entry with the API code
|
| ``-b``, ``--battery=BATTERY``
| Send battery state (0 = low, 1 = normal) for weather
| stations
|
| ``-c``, ``--code=RAW_CODE``
| Raw code to be transmitted, as emitted by
| ``pilight-debug``
|
| ``-c``, ``--color=COLOR``
| Set a label device to this text color
|
| ``-c``, ``--country=COUNTRY``
| Update a Weather Underground entry with this country
|
| ``-d``, ``--dimlevel=DIMLEVEL``
| Set a dimmer to a specific dimlevel
|
| ``-f``, ``--off``, ``--down``, ``--stopped``
| Send an 'off' (for switches) or 'down' (for screens) or
| 'stopped' (for programs) signal
|
| ``-g``, ``--gpio=GPIO``
| GPIO pin number a device (for example a relay) is
| connected to.
|
| ``-h``, ``--humidity=HUMIDITY``
| Send humidity value for a weather station
|
| ``-i``, ``--id=ID``
| Send a code with this id
|
| ``-l``, ``--label=LABEL``
| Set text of a label device to this text
|
| ``-l``, ``--learn``
| Send multiple streams when a device is in learning mode
| to emulate the learning mode of a remote control.
|
| ``-l``, ``--location=LOCATION``
| Update a Weather Underground entry with this location
|
| ``-n``, ``--name=NAME``
| Name of the program to be controlled
|
| ``-n``, ``--num``
| Use random (super)code sequence number 0..3 (7)
|
| ``-s``, ``--systemcode=SYSTEMCODE``
| Send a code with this systemcode
|
| ``-s``, ``--super``
| Send to all devices, regardless of id
|
| ``-t``, ``--on``, ``--up``, ``--running``
| Send an 'on' (for switches) or 'up' (for screens) or
| 'running' (for programs) signal.
|
| ``-t``, ``--temperature=TEMPERATURE``
| Send temperature value for a weather station
|
| ``-u``, ``--unit=UNITCODE``,
| ``--unitcode=UNITCODE``,
| ``--programcode=PROGRAMCODE``
| Send a code this unitcode. Note that some protocols use
| long option ``--unit`` while others use long option
| ``--unitcode`` or long option ``--programcode``.
|
| ``-u``, ``--update``
| Update a defined Weather Underground entry
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-control``
| ``pilight-daemon``
| ``pilight-debug``
| ``pilight-flash``
| ``pilight-raw``
| ``pilight-receive``
| ``pilight-sha256``
| ``pilight-uuid``
@@ -0,0 +1,70 @@
==============
pilight-sha256
==============
Generate a pilight SHA-256 hash for a password
----------------------------------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-send`` --password PASSWORD
DESCRIPTION
===========
``pilight-sha256`` is a tool to generate a SHA-256 hash for a webgui password to avoid storing cleartext passwords in configuration files.
The hash can be added to config.json under "settings" - "webserver-password". Consult the pilight manual <https://manual.pilight.org/> for configuration details.
Prints the hashed PASSWORD to STDOUT.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
|
| ``-p``, ``--password=PASSWORD``
| Password to hash
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-control``
| ``pilight-daemon``
| ``pilight-debug``
| ``pilight-flash``
| ``pilight-raw``
| ``pilight-receive``
| ``pilight-send``
| ``pilight-uuid``
@@ -0,0 +1,65 @@
============
pilight-uuid
============
Show pilight adhoc node UUID
----------------------------
:Date: 2017
:Copyright: MPLv2
:Version: 7.0
:Manual section: 1
:Manual group: pilight 7.0 man pages
SYNOPSIS
========
| ``pilight-uuid``
DESCRIPTION
===========
``pilight-uuid`` is a tool to show the UUID for a pilight adhoc network node in order to identify as a unique node. This prevents multiple nodes from interfering with each other when sending and receiving.
Prints the UUID to STDOUT.
OPTIONS
=======
Mandatory arguments to long options are mandatory for short options too.
|
| ``-H``, ``--help``
| Print allowed options and exit
|
| ``-V``, ``--version``
| Print version information and exit
BUGS
====
Please report all bugs on GitHub <https://github.com/pilight/pilight/>.
AUTHOR
======
Curlymo <info@pilight.org> and contributors.
This man page was originally written by pilino1234 <pilino1234@zoho.eu>.
WWW
===
https://www.pilight.org/
SEE ALSO
========
| ``pilight-control``
| ``pilight-daemon``
| ``pilight-debug``
| ``pilight-flash``
| ``pilight-raw``
| ``pilight-receive``
| ``pilight-send``
| ``pilight-sha256``