added plugin documentation for intertechno devices
This commit is contained in:
parent
cde0a2c3df
commit
e329ead0f8
@ -17,7 +17,7 @@
|
|||||||
\li \l{JSONRPC Interface}
|
\li \l{JSONRPC Interface}
|
||||||
\li \l{Rules}
|
\li \l{Rules}
|
||||||
\endlist
|
\endlist
|
||||||
\li Device plugins. A collection of officially supported device plugins.
|
\li \l{Plugins}. A collection of officially supported device plugins.
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
\section2 Quicklinks
|
\section2 Quicklinks
|
||||||
|
|||||||
8
doc/plugins.qdoc
Normal file
8
doc/plugins.qdoc
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/*!
|
||||||
|
\page plugins.html
|
||||||
|
\title Plugins
|
||||||
|
|
||||||
|
\annotatedlist plugins
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
@ -20,16 +20,14 @@
|
|||||||
#include "gpio.h"
|
#include "gpio.h"
|
||||||
#include <QDebug>
|
#include <QDebug>
|
||||||
|
|
||||||
/*! Constructs a \l{Gpio} object to represent a GPIO with the given \a gpio number and the \a parent.
|
/*! Constructs a \l{Gpio} object to represent a GPIO with the given \a gpio number and the \a parent. */
|
||||||
*/
|
|
||||||
Gpio::Gpio(QObject *parent, int gpio) :
|
Gpio::Gpio(QObject *parent, int gpio) :
|
||||||
QThread(parent),m_gpio(gpio)
|
QThread(parent),m_gpio(gpio)
|
||||||
{
|
{
|
||||||
exportGpio();
|
exportGpio();
|
||||||
}
|
}
|
||||||
|
|
||||||
/*! Destroys the Gpio object and unexports the GPIO.
|
/*! Destroys the Gpio object and unexports the GPIO. */
|
||||||
*/
|
|
||||||
Gpio::~Gpio()
|
Gpio::~Gpio()
|
||||||
{
|
{
|
||||||
unexportGpio();
|
unexportGpio();
|
||||||
|
|||||||
@ -31,8 +31,8 @@ Radio433::Radio433(QObject *parent) :
|
|||||||
|
|
||||||
m_receiver->start();
|
m_receiver->start();
|
||||||
}
|
}
|
||||||
/*! Destroyes the \l{Radio433} object and stops the running threads.
|
|
||||||
*/
|
/*! Destroyes the \l{Radio433} object and stops the running threads. */
|
||||||
Radio433::~Radio433()
|
Radio433::~Radio433()
|
||||||
{
|
{
|
||||||
m_receiver->quit();
|
m_receiver->quit();
|
||||||
@ -66,8 +66,7 @@ void Radio433::sendData(QList<int> rawData)
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/*! Returns the current system time in microseconds.
|
/*! Returns the current system time in microseconds. */
|
||||||
*/
|
|
||||||
int Radio433::micros()
|
int Radio433::micros()
|
||||||
{
|
{
|
||||||
struct timeval tv ;
|
struct timeval tv ;
|
||||||
@ -79,8 +78,7 @@ int Radio433::micros()
|
|||||||
return (int)(now - m_epochMicro) ;
|
return (int)(now - m_epochMicro) ;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*! Creates a delay of a certain time (\a microSeconds).
|
/*! Creates a delay of a certain time (\a microSeconds). */
|
||||||
*/
|
|
||||||
void Radio433::delayMicros(int microSeconds)
|
void Radio433::delayMicros(int microSeconds)
|
||||||
{
|
{
|
||||||
struct timespec sleeper;
|
struct timespec sleeper;
|
||||||
|
|||||||
@ -1,3 +1,25 @@
|
|||||||
|
/*!
|
||||||
|
\page intertechno.html
|
||||||
|
\title Intertechno
|
||||||
|
|
||||||
|
\ingroup plugins
|
||||||
|
|
||||||
|
This plugin supports al Intertechno RF 433 MHz devices from following list:
|
||||||
|
|
||||||
|
\table
|
||||||
|
\header
|
||||||
|
\li Model
|
||||||
|
\li Device Type
|
||||||
|
\row
|
||||||
|
\li 0
|
||||||
|
\li LOW
|
||||||
|
\row
|
||||||
|
\li 1
|
||||||
|
\li HIGH
|
||||||
|
\endtable
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
#include "devicepluginintertechno.h"
|
#include "devicepluginintertechno.h"
|
||||||
|
|
||||||
#include "device.h"
|
#include "device.h"
|
||||||
|
|||||||
@ -1,6 +1,7 @@
|
|||||||
#ifndef DEVICEPLUGININTERTECHNO_H
|
#ifndef DEVICEPLUGININTERTECHNO_H
|
||||||
#define DEVICEPLUGININTERTECHNO_H
|
#define DEVICEPLUGININTERTECHNO_H
|
||||||
|
|
||||||
|
|
||||||
#include "deviceplugin.h"
|
#include "deviceplugin.h"
|
||||||
|
|
||||||
class DevicePluginIntertechno : public DevicePlugin
|
class DevicePluginIntertechno : public DevicePlugin
|
||||||
|
|||||||
Reference in New Issue
Block a user