forked from Zefau/ioBroker.roomba
-
Notifications
You must be signed in to change notification settings - Fork 4
/
_NODES.js
125 lines (108 loc) · 11.8 KB
/
_NODES.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
module.exports =
[
// commands
{'node': 'commands', 'description': 'Actions and information of the cleaning process', 'type': 'channel'},
{'node': 'commands._runCommand', 'description': 'Run any command (see https://bit.ly/2S57cgM)', 'role': 'text', 'type': 'string', 'common': { 'write': true } },
{'node': 'commands.start', 'description': 'Start a cleaning process', 'action': 'start', 'role': 'button.start', 'type': 'boolean'},
{'node': 'commands.stop', 'description': 'Stop the current cleaning process', 'action': 'stop', 'role': 'button.stop', 'type': 'boolean'},
{'node': 'commands.pause', 'description': 'Pause the current cleaning process', 'action': 'pause', 'role': 'button.pause', 'type': 'boolean'},
{'node': 'commands.resume', 'description': 'Resume the current cleaning process', 'action': 'resume', 'role': 'button.resume', 'type': 'boolean'},
{'node': 'commands.dock', 'description': 'Send the robot to the docking station', 'action': 'dock', 'role': 'button', 'type': 'boolean'},
// commands - last command
{'node': 'commands.last', 'description': 'Last processed command', 'type': 'channel'},
{'node': 'commands.last.command', 'description': 'Last command sent to robot', 'preference': 'lastCommand.command', 'role': 'text'},
{'node': 'commands.last.timestamp', 'description': 'Timestamp last command was sent', 'preference': 'lastCommand.time', 'kind': 'timestamp', 'role': 'value', 'type': 'number'},
{'node': 'commands.last.dateTime', 'description': 'DateTime last command was sent', 'preference': 'lastCommand.time', 'kind': 'datetime', 'role': 'text'},
{'node': 'commands.last.initiator', 'description': 'Initiator of last command', 'preference': 'lastCommand.initiator', 'role': 'text'},
// missions
{'node': 'missions', 'description': 'Mission information', 'type': 'channel'},
{'node': 'missions.history', 'description': 'History of all missions', 'role': 'json'},
// missions - current
{'node': 'missions.current', 'description': 'Mission information about current running mission', 'type': 'channel'},
//{'node': 'missions.current._endMission', 'description': 'End mission and save to history', 'action': true, 'role': 'button', 'type': 'boolean'},
{'node': 'missions.current._data', 'description': 'All data of current mission', 'role': 'json'},
{'node': 'missions.current.mapImage', 'description': 'Image of the map of current mission', 'role': 'text'},
{'node': 'missions.current.mapHTML', 'description': 'HTML for the map of current mission', 'role': 'text'},
{'node': 'missions.current.mapSize', 'description': 'Size (in px) of the map', 'role': 'json'},
{'node': 'missions.current.path', 'description': 'Path of current mission', 'role': 'text'},
{'node': 'missions.current.id', 'description': 'ID of current mission', 'role': 'value', 'type': 'number'},
{'node': 'missions.current.started', 'description': 'Timestamp when the current mission has started', 'role': 'value', 'type': 'number'},
{'node': 'missions.current.startedDateTime', 'description': 'DateTime when the current mission has started', 'role': 'text'},
{'node': 'missions.current.ended', 'description': 'Timestamp when the current mission has ended', 'role': 'value'},
{'node': 'missions.current.endedDateTime', 'description': 'DateTime when the current mission has ended', 'role': 'text'},
{'node': 'missions.current.runtime', 'description': 'Runtime in seconds of the current mission', 'role': 'value', 'type': 'number'},
{'node': 'missions.current.initiator', 'description': 'Initiator of current mission', 'role': 'text'},
{'node': 'missions.current.cycle', 'description': 'Cycle mode of current mission', 'role': 'text'},
{'node': 'missions.current.phase', 'description': 'Phase of current mission', 'preference': 'cleanMissionStatus.phase', 'role': 'text'},
{'node': 'missions.current.error', 'description': 'Indicates an error during last mission', 'preference': 'cleanMissionStatus.error', 'role': 'indicator', 'type': 'boolean'},
{'node': 'missions.current.sqm', 'description': 'Cleaned square-meters of current mission', 'role': 'text'},
// missions - schedule
{'node': 'missions.schedule', 'description': 'Schedule of the cleaning process', 'type': 'channel'},
{'node': 'missions.schedule.cycle', 'description': 'Schedule cycle (Sunday to Saturday)', 'preference': 'cleanSchedule.cycle', 'role': 'text', 'common': { 'write': true } },
{'node': 'missions.schedule.hours', 'description': 'Hour to start cycle (Sunday to Saturday)', 'preference': 'cleanSchedule.h', 'role': 'text', 'common': { 'write': true } },
{'node': 'missions.schedule.minutes', 'description': 'Minute to start cycle (Sunday to Saturday)', 'preference': 'cleanSchedule.m', 'role': 'text', 'common': { 'write': true } },
// device
{'node': 'device', 'description': 'Device information', 'type': 'channel'},
{'node': 'device.mac', 'description': 'Mac address of the robot', 'preference': 'mac', 'role': 'info.mac'},
{'node': 'device.name', 'description': 'Name of the robot', 'preference': 'name', 'role': 'info.name'},
{'node': 'device.type', 'description': 'Type of the robot', 'preference': 'sku', 'role': 'text'},
// device - network
{'node': 'device.network', 'description': 'Network settings', 'type': 'channel'},
{'node': 'device.network.dhcp', 'description': 'State whether DHCP is activated', 'preference': 'netinfo.dhcp', 'type': 'boolean'},
{'node': 'device.network.router', 'description': 'Mac address of router', 'preference': 'netinfo.bssid', 'role': 'text'},
{'node': 'device.network.ip', 'description': 'IP address', 'preference': 'netinfo.addr', 'exception': '0.0.0.0', 'kind': 'ip', 'role': 'info.ip'},
{'node': 'device.network.subnet', 'description': 'Subnet adress', 'preference': 'netinfo.mask', 'exception': '0.0.0.0', 'kind': 'ip', 'role': 'info.ip'},
{'node': 'device.network.gateway', 'description': 'Gateway address', 'preference': 'netinfo.gw', 'exception': '0.0.0.0', 'kind': 'ip', 'role': 'info.ip'},
{'node': 'device.network.dns1', 'description': 'Primary DNS address', 'preference': 'netinfo.dns1', 'exception': '0.0.0.0', 'kind': 'ip', 'role': 'info.ip'},
{'node': 'device.network.dns2', 'description': 'Secondary DNS address', 'preference': 'netinfo.dns2', 'exception': '0.0.0.0', 'kind': 'ip', 'role': 'info.ip'},
// device - versions
{'node': 'device.versions', 'description': 'Hardware and softare versions', 'type': 'channel'},
{'node': 'device.versions.hardwareRev', 'description': 'Hardware Revision', 'preference': 'hardwareRev', 'role': 'value', 'type': 'number'},
{'node': 'device.versions.batteryType', 'description': 'Battery Type', 'preference': 'batteryType', 'role': 'text'},
{'node': 'device.versions.soundVer', 'description': '', 'preference': 'soundVer', 'role': 'text'},
{'node': 'device.versions.uiSwVer', 'description': '', 'preference': 'uiSwVer', 'role': 'text'},
{'node': 'device.versions.navSwVer', 'description': '', 'preference': 'navSwVer', 'role': 'text'},
{'node': 'device.versions.wifiSwVer', 'description': '', 'preference': 'wifiSwVer', 'role': 'text'},
{'node': 'device.versions.mobilityVer', 'description': '', 'preference': 'mobilityVer', 'role': 'text'},
{'node': 'device.versions.bootloaderVer', 'description': 'Bootloader Version', 'preference': 'bootloaderVer', 'role': 'text'},
{'node': 'device.versions.umiVer', 'description': '', 'preference': 'umiVer', 'role': 'text'},
{'node': 'device.versions.softwareVer', 'description': 'Software Version', 'preference': 'softwareVer', 'role': 'text'},
// preferences
{'node': 'device.preferences', 'description': 'Preferences', 'type': 'channel'},
{'node': 'device.preferences.noAutoPasses', 'description': 'One Pass: Roomba will cover all areas with a single cleaning pass.', 'preference': 'noAutoPasses', 'role': 'state', 'type': 'boolean'},
{'node': 'device.preferences.noPP', 'description': '', 'preference': 'noPP', 'role': 'state', 'type': 'boolean'},
{'node': 'device.preferences.binPause', 'description': '', 'preference': 'binPause', 'role': 'state', 'type': 'boolean'},
{'node': 'device.preferences.openOnly', 'description': '', 'preference': 'openOnly', 'role': 'state', 'type': 'boolean'},
{'node': 'device.preferences.twoPass', 'description': 'Roomba will cover all areas a second time. This may be helpful in homes with pets or for occasional deep cleaning.', 'preference': 'twoPass', 'role': 'state', 'type': 'boolean'},
{'node': 'device.preferences.schedHold', 'description': '', 'preference': 'schedHold', 'role': 'state', 'type': 'boolean'},
{'node': 'device.preferences.carpetBoostAuto', 'description': 'Automatic: Roomba will automatically boost its vacuum power to deep clean carpets.', 'preference': 'carpetBoost', 'role': 'state', 'type': 'boolean'},
{'node': 'device.preferences.carpetBoostHigh', 'description': 'Performance Mode: Roomba will always boost its vacuum to maximise cleaning performance on all floor surfaces.', 'preference': 'vacHigh', 'role': 'state', 'type': 'boolean'},
{'node': 'device.preferences.ecoCharge', 'description': '', 'preference': 'ecoCharge', 'role': 'state', 'type': 'boolean'},
// states
{'node': 'states', 'description': 'Status information', 'type': 'channel'},
{'node': 'states.battery', 'description': 'Battery level of the robot', 'preference': 'batPct', 'role': 'value.battery', 'type': 'number', 'unit': '%'},
{'node': 'states.docked', 'description': 'State whether robot is docked', 'preference': 'dock.known', 'role': 'indicator', 'type': 'boolean'},
{'node': 'states.binInserted', 'description': 'State whether bin is inserted', 'preference': 'bin.present', 'role': 'indicator', 'type': 'boolean'},
{'node': 'states.binFull', 'description': 'State whether bin status is full', 'preference': 'bin.full', 'role': 'indicator', 'type': 'boolean'},
{'node': 'states.status', 'description': 'Current status of the robot', 'preference': 'cleanMissionStatus.phase', 'role': 'text'},
{'node': 'states.signal', 'description': 'Signal strength', 'preference': 'signal.snr', 'role': 'value', 'type': 'number'},
// statistics
{'node': 'statistics', 'description': 'Statistics', 'type': 'channel'},
// statistics - missions
{'node': 'statistics.time', 'description': 'Time based Statistics', 'type': 'channel'},
{'node': 'statistics.time.avgMin', 'description': '', 'preference': 'bbchg3.avgMin', 'role': 'value', 'type': 'number'},
{'node': 'statistics.time.hOnDock', 'description': '', 'preference': 'bbchg3.hOnDock', 'role': 'value', 'type': 'number'},
{'node': 'statistics.time.nAvail', 'description': '', 'preference': 'bbchg3.nAvail', 'role': 'value', 'type': 'number'},
{'node': 'statistics.time.estCap', 'description': '', 'preference': 'bbchg3.estCap', 'role': 'value', 'type': 'number'},
{'node': 'statistics.time.nLithChrg', 'description': '', 'preference': 'bbchg3.nLithChrg', 'role': 'value', 'type': 'number'},
{'node': 'statistics.time.nNimhChrg', 'description': '', 'preference': 'bbchg3.nNimhChrg', 'role': 'value', 'type': 'number'},
{'node': 'statistics.time.nDocks', 'description': '', 'preference': 'bbchg3.nDocks', 'role': 'value', 'type': 'number'},
// statistics - missions
{'node': 'statistics.missions', 'description': 'Mission based Statistics', 'type': 'channel'},
{'node': 'statistics.missions.total', 'description': 'Number of cleaning jobs', 'preference': 'bbmssn.nMssn', 'role': 'value', 'type': 'number'},
{'node': 'statistics.missions.succeed', 'description': 'Number of successful cleaning jobs', 'preference': 'bbmssn.nMssnOk', 'role': 'value', 'type': 'number'},
//{'node': 'statistics.missionsC', 'description': '', 'preference': 'bbmssn.nMssnC', 'role': 'value'},
{'node': 'statistics.missions.failed', 'description': 'Number of failed cleaning jobs', 'preference': 'bbmssn.nMssnF', 'role': 'value', 'type': 'number'},
//{'node': 'statistics.missions', 'description': '', 'preference': 'bbmssn.aMssnM', 'role': 'value'},
//{'node': 'statistics.missions', 'description': '', 'preference': 'bbmssn.aCycleM', 'role': 'value'},
];