node-red-contrib-padavan 1.0.0

package/nodes/devices.js

@@ -0,0 +1,27 @@
+module.exports = function(RED) {
+	function Devices(config) {
+		RED.nodes.createNode(this, config);
+		const settings = RED.nodes.getNode(config.settings);
+		this.on('input', msg => {
+			settings.getClient().then(client => client.getDevices())
+			.then(payload => {
+				if (!payload)
+					return;
+				msg.payload = payload;
+				msg.numConnectedDevices = payload.length;
+				this.status({
+					fill: 'green',
+					shape: 'dot',
+					text: msg.numConnectedDevices
+				});
+				this.send(msg);
+			})
+			.catch(({ message, code }) => {
+				msg.code = code;
+				msg.payload = message;
+				this.error(message, msg);
+			});
+		});
+	};
+	RED.nodes.registerType('padavan-devices', Devices);
+}

package/nodes/history.html

@@ -0,0 +1,27 @@
+<script type="text/html" data-template-name="padavan-history">
+	<div class="form-row">
+		<label for="node-input-settings"><i class="fa fa-cog"></i> Config</label>
+		<input id="node-input-settings" />
+	</div>
+	<div class="form-row">
+		<label for="node-input-name"><i class="fa fa-pencil"></i> Name</label>
+		<input type="text" id="node-input-name" />
+	</div>
+</script>
+<script type="text/javascript">
+RED.nodes.registerType('padavan-history', {
+	category: 'Padavan',
+	defaults: {
+		settings: { value: null, required: true, type: 'padavan-config' },
+		name: { value: '' }
+	},
+	icon: 'font-awesome/fa-history',
+	inputs: 1,
+	outputs: 1,
+	color: '#49afcd',
+	paletteLabel: 'History',
+	label: function() {
+		return this.name || 'History';
+	}
+});
+</script>

package/nodes/history.js

@@ -0,0 +1,32 @@
+module.exports = function(RED) {
+	function History(config) {
+		RED.nodes.createNode(this, config);
+		const settings = RED.nodes.getNode(config.settings);
+		this.on('input', msg => {
+			settings.getClient().then(client => client.getHistory())
+			.then(payload => {
+				if (!payload)
+					return;
+				const kb = payload.monthly_history.slice(-1)[0].slice(1).reduce((a, b) => a + b, 0);
+				const k = kb > 0 ? Math.floor((Math.log2(kb)/10)) : 0;
+				const rank = (k > 0 ? 'MGT'[k - 1] : '') + 'b';
+				const count = Math.floor(kb / Math.pow(1024, k));
+				msg.networkUsage = count + rank;
+				msg.networkUsageMB = parseInt(kb / 1024);
+				msg.payload = payload;
+				this.status({
+					fill: 'green',
+					shape: 'dot',
+					text: msg.networkUsage
+				});
+				this.send(msg);
+			})
+			.catch(({ message, code }) => {
+				msg.code = code;
+				msg.payload = message;
+				this.error(message, msg);
+			});
+		});
+	};
+	RED.nodes.registerType('padavan-history', History);
+}

package/nodes/locales/en-US/config.html

@@ -0,0 +1,12 @@
+<script type="text/markdown" data-help-name="padavan-config">
+### Input
+
+| credentials   | Description
+| ---           | ---
+| *`repo`*      | Repository where firmware builds are hosted
+| *`branch`*    | Branch for the device
+| *`token`*     | Access token for GitHub
+| `host`        | Router IP address
+| `username`    | Username for router access
+| `password`    | Password for router access
+</script>

package/nodes/locales/en-US/devices.html

@@ -0,0 +1,19 @@
+<script type="text/markdown" data-help-name="padavan-devices">
+Get the list of connected devices
+
+
+### Output
+
+| msg                   | type
+| ---                   | ---
+| `payload`             | array
+| `numConnectedDevices` | integer
+
+
+| payload       |
+| ---           |
+| `hostname`    |
+| `ip`          |
+| `mac`         |
+| `rssi`        |
+</script>

package/nodes/locales/en-US/history.html

@@ -0,0 +1,25 @@
+<script type="text/markdown" data-help-name="padavan-history">
+Retrieve traffic history
+
+
+### Output
+
+| msg               | type
+| ---               | ---
+| `payload`         | object
+| `networkUsage`    | string
+| `networkUsageMB`  | integer
+
+
+| payload           | type  | Description
+| ---               | ---   | ---
+| `daily_history`   | array | Daily
+| `monthly_history` | array | Monthly
+
+
+| \*\_history   | Description
+| ---           | ---
+| `0`           | Year, month, day
+| `1`           | Download
+| `2`           | Upload
+</script>

package/nodes/locales/en-US/params.html

@@ -0,0 +1,39 @@
+<script type="text/markdown" data-help-name="padavan-params">
+Retrieve and modify parameters
+
+
+### Input
+
+| msg           | type
+| ---           | ---
+| *`payload`*   | object
+| `topic`       | string
+
+
+| topic     | Description
+| ---       | ---
+| *`list`*  | Retrieve all parameters
+| *`get`*   | Retrieve specific parameters
+| *`set`*   | Modify parameters
+
+
+| payload           |
+| ---               |
+| *`sid_list`*      |
+| *`action_mode`*   |
+
+
+### Output
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+| `payload` | object
+
+
+### Details
+
+If `sid_list` is specified, changes will be sent via the web panel.
+
+If `action_mode` is not specified, it will be sent as ` Apply `.
+</script>

package/nodes/locales/en-US/speedtest.html

@@ -0,0 +1,24 @@
+<script type="text/markdown" data-help-name="padavan-speedtest">
+Measure download and upload speeds
+
+
+### Output
+
+| outputs       | Description
+| ---           | ---
+| `result`      | Result
+| `history`     | Result with date and timestamp
+| `progress`    | Test start and end
+
+
+| result.msg    | type      | Value
+| ---           | ---       | ---
+| `topic`       | string    | NetworkControl
+| `payload`     | object    |
+
+
+| payload                   | Description
+| ---                       | ---
+| `networkDownloadSpeedMbps`| Download speed
+| `networkUploadSpeedMbps`  | Upload speed
+</script>

package/nodes/locales/en-US/system.html

@@ -0,0 +1,79 @@
+<script type="text/markdown" data-help-name="padavan-system">
+Retrieve and manage router status
+
+
+### Input
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+
+
+| topic         | Description
+| ---           | ---
+| *`status`*    | Get current status
+| *`log`*       | Get logs
+| *`reboot`*    | Reboot
+
+
+### Output
+
+| msg       | type      | Value
+| ---       | ---       | ---
+| `topic`   | string    | status
+| `payload` | object    |
+
+
+| payload   | Description
+| ---       | ---
+| `lavg`    | System load average over the last 1, 5, and 15 minutes
+| `uptime`  | Router uptime
+| `ram`     | RAM usage information
+| `swap`    | Swap memory status
+| `cpu`     | CPU load information
+| `wifi2`   | Wi-Fi status on the 2.4 GHz band
+| `wifi5`   | Wi-Fi status on the 5 GHz band
+| `logmt`   | Timestamp of the last log modification
+
+
+| uptime    |
+| ---       |
+| `days`    |
+| `hours`   |
+| `minutes` |
+
+
+| ram       | Description
+| ---       | ---
+| `total`   | Total RAM (in KB)
+| `used`    | Used RAM
+| `free`    | Free RAM
+| `buffers` | RAM used for buffers
+| `cached`  | RAM used for cache
+
+
+| swap      |
+| ---       |
+| `total`   |
+| `used`    |
+| `free`    |
+
+
+| cpu       | Description
+| ---       | ---
+| `busy`    | Total time the CPU has been busy
+| `user`    | Time spent on user processes
+| `nice`    | Time spent on processes with modified priority
+| `system`  | Time spent on system processes
+| `idle`    | Idle time when the CPU was not busy
+| `iowait`  | Time spent waiting for I/O operations
+| `irq`     | Time spent on hardware interrupt handling
+| `sirq`    | Time spent on software interrupt handling
+| `total`   | Total units of time since the system started
+
+
+| wifi\*    | Description
+| ---       | ---
+| `state`   | Network state
+| `guest`   | Guest network state
+</script>

package/nodes/locales/en-US/upgrade.html

@@ -0,0 +1,33 @@
+<script type="text/markdown" data-help-name="padavan-upgrade">
+Manage firmware updates
+
+
+### Input
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+
+
+| topic         | Description
+| ---           | ---
+| *`build`*     | Build firmware
+| *`changelog`* | List of changes
+| *`upgrade`*   | Install firmware
+
+
+### Output
+
+| msg       | type      | Value
+| ---       | ---       | ---
+| `topic`   | string    | changelog
+| `error`   | string    |
+| `payload` | object    |
+
+
+| payload   | Description
+| ---       | ---
+| `from_id` | Current firmware
+| `to_id`   | Built firmware
+| `data`    | Array of changes
+</script>

package/nodes/locales/ru/config.html

@@ -0,0 +1,12 @@
+<script type="text/markdown" data-help-name="padavan-config">
+### Принимает
+
+| credentials   | Описание
+| ---           | ---
+| *`repo`*      | Репозиторий где собираются прошивки
+| *`branch`*    | Ветка для устройства
+| *`token`*     | Токен для доступа к github
+| `host`        | IP роутера
+| `username`    | Логин для доступа к роутеру
+| `password`    | Пароль для доступа к роутеру
+</script>

package/nodes/locales/ru/devices.html

@@ -0,0 +1,19 @@
+<script type="text/markdown" data-help-name="padavan-devices">
+Получить список устройств
+
+
+### Выводит
+
+| msg                   | type
+| ---                   | ---
+| `payload`             | array
+| `numConnectedDevices` | integer
+
+
+| payload       |
+| ---           |
+| `hostname`    |
+| `ip`          |
+| `mac`         |
+| `rssi`        |
+</script>

package/nodes/locales/ru/history.html

@@ -0,0 +1,25 @@
+<script type="text/markdown" data-help-name="padavan-history">
+Получить историю трафика
+
+
+### Выводит
+
+| msg               | type
+| ---               | ---
+| `payload`         | object
+| `networkUsage`    | string
+| `networkUsageMB`  | integer
+
+
+| payload           | type  | Описание
+| ---               | ---   | ---
+| `daily_history`   | array | Ежедневно
+| `monthly_history` | array | Ежемесячно
+
+
+| \*\_history   | Описание
+| ---           | ---
+| `0`           | Год, месяц, день
+| `1`           | Загрузка
+| `2`           | Отдача
+</script>

package/nodes/locales/ru/params.html

@@ -0,0 +1,39 @@
+<script type="text/markdown" data-help-name="padavan-params">
+Получение и изменение параметров
+
+
+### Принимает
+
+| msg           | type
+| ---           | ---
+| *`payload`*   | object
+| `topic`       | string
+
+
+| topic     | Описание
+| ---       | ---
+| *`list`*  | Получить все параметры
+| *`get`*   | Получить определенные параметры
+| *`set`*   | Изменить параметры
+
+
+| payload           |
+| ---               |
+| *`sid_list`*      |
+| *`action_mode`*   |
+
+
+### Выводит
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+| `payload` | object
+
+
+### Подробности
+
+Если указан `sid_list`, то изменения будут отправляться через веб-панель.
+
+Если не указан `action_mode`, то будет отправляться как ` Apply `.
+</script>

package/nodes/locales/ru/speedtest.html

@@ -0,0 +1,24 @@
+<script type="text/markdown" data-help-name="padavan-speedtest">
+Измерить скорость скачивания и загрузки
+
+
+### Выводит
+
+| outputs       | Описание
+| ---           | ---
+| `result`      | Результат
+| `history`     | Результат с датой и timestamp
+| `progress`    | Запуск и окончание теста
+
+
+| result.msg    | type      | Значение
+| ---           | ---       | ---
+| `topic`       | string    | NetworkControl
+| `payload`     | object    |
+
+
+| payload                   | Описание
+| ---                       | ---
+| `networkDownloadSpeedMbps`| Скорость скачивания
+| `networkUploadSpeedMbps`  | Скорость загрузки
+</script>

package/nodes/locales/ru/system.html

@@ -0,0 +1,79 @@
+<script type="text/markdown" data-help-name="padavan-system">
+Получение и управление состоянием роутера
+
+
+### Принимает
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+
+
+| topic         | Описание
+| ---           | ---
+| *`status`*    | Получить текущее состояние
+| *`log`*       | Получить логи
+| *`reboot`*    | Перезагрузить
+
+
+### Выводит
+
+| msg       | type      | Значение
+| ---       | ---       | ---
+| `topic`   | string    | status
+| `payload` | object    |
+
+
+| payload   | Описание
+| ---       | ---
+| `lavg`    | Средняя загрузка системы за последние 1, 5 и 15 минут
+| `uptime`  | Время работы роутера без перезагрузки
+| `ram`     | Информация об использовании RAM
+| `swap`    | Информация о состоянии подкачки
+| `cpu`     | Информация о загрузке процессора
+| `wifi2`   | Состояние сети Wi-Fi на частоте 2.4 GHz
+| `wifi5`   | Состояние сети Wi-Fi на частоте 5 GHz
+| `logmt`   | Метка времени последнего изменения логов
+
+
+| uptime    |
+| ---       |
+| `days`    |
+| `hours`   |
+| `minutes` |
+
+
+| ram       | Описание
+| ---       | ---
+| `total`   | Общий объём оперативной памяти (в КБ)
+| `used`    | Объём использованной памяти
+| `free`    | Объём свободной памяти
+| `buffers` | Объём памяти, используемой под буферы
+| `cached`  | Объём памяти, используемой под кэш
+
+
+| swap      |
+| ---       |
+| `total`   |
+| `used`    |
+| `free`    |
+
+
+| cpu       | Описание
+| ---       | ---
+| `busy`    | Суммарное время, когда процессор был занят
+| `user`    | Время, затраченное процессором на выполнение пользовательских процессов
+| `nice`    | Время, затраченное процессором на процессы с изменённым приоритетом
+| `system`  | Время, затраченное процессором на выполнение системных процессов
+| `idle`    | Время простоя процессора, когда он не был занят
+| `iowait`  | Время, которое процессор ждал завершения операций ввода-вывода
+| `irq`     | Время, затраченное процессором на обработку аппаратных прерываний
+| `sirq`    | Время, затраченное процессором на обработку программных прерываний
+| `total`   | Общее количество единиц времени с момента запуска системы
+
+
+| wifi\*    | Описание
+| ---       | ---
+| `state`   | Состояние сети
+| `guest`   | Состояние гостевой сети
+</script>

package/nodes/locales/ru/upgrade.html

@@ -0,0 +1,33 @@
+<script type="text/markdown" data-help-name="padavan-upgrade">
+Управление прошивками
+
+
+### Принимает
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+
+
+| topic         | Описание
+| ---           | ---
+| *`build`*     | Собрать прошивку
+| *`changelog`* | Список изменений
+| *`upgrade`*   | Установить прошивку
+
+
+### Выводит
+
+| msg       | type      | Значение
+| ---       | ---       | ---
+| `topic`   | string    | changelog
+| `error`   | string    |
+| `payload` | object    |
+
+
+| payload   | Описание
+| ---       | ---
+| `from_id` | Текущая прошивка
+| `to_id`   | Собранная прошивка
+| `data`    | Массив с изменениями
+</script>

package/nodes/params.html

@@ -0,0 +1,60 @@
+<script type="text/html" data-template-name="padavan-params">
+	<div class="form-row">
+		<label for="node-input-settings"><i class="fa fa-cog"></i> Config</label>
+		<input id="node-input-settings" />
+	</div>
+	<div class="form-row">
+		<label for="node-input-name"><i class="fa fa-pencil"></i> Name</label>
+		<input type="text" id="node-input-name" />
+	</div>
+	<div class="form-row">
+		<label for="node-input-payload"><i class="fa fa-cogs"></i> Payload</label>
+		<input type="text" id="node-input-payload">
+		<input type="hidden" id="node-input-payloadType">
+	</div>
+	<div class="form-row">
+		<label for="node-input-topic"><i class="fa fa-envelope-o"></i> Topic</label>
+		<input type="text" id="node-input-topic">
+		<input type="hidden" id="node-input-topicType">
+	</div>
+</script>
+<script type="text/javascript">
+RED.nodes.registerType('padavan-params', {
+	category: 'Padavan',
+	defaults: {
+		settings: { value: null, required: true, type: 'padavan-config' },
+		name: { value: '' },
+		payload: { value: 'payload' },
+		payloadType: { value: 'msg' },
+		topic: { value: 'topic' },
+		topicType: { value: 'msg' }
+	},
+	icon: 'font-awesome/fa-cogs',
+	inputs: 1,
+	outputs: 1,
+	color: '#49afcd',
+	paletteLabel: 'Params',
+	label: function() {
+		return this.name || 'Params';
+	},
+	oneditprepare: function() {
+		$('#node-input-payload').typedInput({
+			types: [ 'msg', 'str', 'json' ],
+			typeField: '#node-input-payloadType'
+		});
+		$('#node-input-topic').typedInput({
+			types: [ 'msg', {
+				value: 'action',
+				options: [ 'list', 'get', 'set' ]
+			}],
+			typeField: '#node-input-topicType'
+		}).on('change', ev => {
+			const el = $('#node-input-payload').parent();
+			if (ev.target.value === 'list')
+				el.hide();
+			else
+				el.show();
+		});
+	}
+});
+</script>

package/nodes/params.js

@@ -0,0 +1,35 @@
+module.exports = function(RED) {
+	function Params(config) {
+		RED.nodes.createNode(this, config);
+		const settings = RED.nodes.getNode(config.settings);
+		this.on('input', msg => {
+			msg.payload = RED.util.evaluateNodeProperty(config.payload, config.payloadType, this, msg);
+			msg.topic = RED.util.evaluateNodeProperty(config.topic, config.topicType, this, msg);
+			if ([ 'list', 'get', 'set' ].includes(msg.topic))
+				settings.getClient().then(client => {
+					if (msg.topic === 'list')
+						return client.getParams();
+					else{
+						if (!msg.payload || !Object.keys(msg.payload).length)
+							throw new Error('Input payload missing');
+						if (msg.topic === 'get')
+							return client.getParams(msg.payload);
+						else if (msg.topic === 'set')
+							return client.setParams(msg.payload);
+					}
+				})
+				.then(payload => {
+					if (!payload)
+						return;
+					msg.payload = payload;
+					this.send(msg);
+				})
+				.catch(({ message, code }) => {
+					msg.code = code;
+					msg.payload = message;
+					this.error(message, msg);
+				});
+		});
+	};
+	RED.nodes.registerType('padavan-params', Params);
+}