VLCB
Toggle main menu visibility
Loading...
Searching...
No Matches
SerialUserInterface.h
Go to the documentation of this file.
1
// Copyright (C) Sven Rosvall (sven@rosvall.ie)
2
// This file is part of VLCB-Arduino project on https://github.com/SvenRosvall/VLCB-Arduino
3
// Licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
4
// The full licence can be found at: http://creativecommons.org/licenses/by-nc-sa/4.0/
5
6
#pragma once
7
8
#include <Arduino.h>
9
#include <Stream.h>
10
11
#include "
Service.h
"
12
#include "
Configuration.h
"
13
#include "
Transport.h
"
14
15
namespace
VLCB
16
{
22
class
SerialUserInterface
:
public
Service
23
{
24
public
:
25
SerialUserInterface
(Stream& _serial = Serial) : serial(_serial) {}
26
28
virtual
VlcbServiceTypes
getServiceID
()
const override
{
return
SERVICE_ID_NONE
; };
29
virtual
byte
getServiceVersionID
()
const override
{
return
1; };
30
31
virtual
void
process
()
override
;
32
virtual
void
processAction
(
const
Action
&action)
override
;
34
35
private
:
36
Stream& serial;
37
38
void
handleAction(
const
Action
&action);
39
void
processSerialInput();
40
void
indicateMode(
VlcbModeParams
i);
41
};
42
43
}
Configuration.h
Service.h
Transport.h
VLCB::SerialUserInterface::SerialUserInterface
SerialUserInterface(Stream &_serial=Serial)
Definition
SerialUserInterface.h:25
VLCB::SerialUserInterface::getServiceVersionID
virtual byte getServiceVersionID() const override
Return the version of the service specification implemented by this service.
Definition
SerialUserInterface.h:29
VLCB::SerialUserInterface::processAction
virtual void processAction(const Action &action) override
Called when there is an action available.
Definition
SerialUserInterface.cpp:20
VLCB::SerialUserInterface::getServiceID
virtual VlcbServiceTypes getServiceID() const override
Return a unique ID for this service.
Definition
SerialUserInterface.h:28
VLCB::Service
Interface base class for all VLCB services.
Definition
Service.h:25
VLCB
Definition
AbstractEventTeachingService.cpp:13
VLCB::process
void process()
Definition
VLCB.cpp:192
VLCB::Action
An action to be performed.
Definition
Controller.h:86
VlcbModeParams
VlcbModeParams
Definition
vlcbdefs.hpp:562
VlcbServiceTypes
VlcbServiceTypes
Definition
vlcbdefs.hpp:487
SERVICE_ID_NONE
@ SERVICE_ID_NONE
Definition
vlcbdefs.hpp:491
src
SerialUserInterface.h
Generated by
1.18.0