Skip to content

Commit

Permalink
Health: NO-ACK status now displayed
Browse files Browse the repository at this point in the history
  • Loading branch information
@tcharp38
tcharp38 committed Sep 19, 2023
1 parent 5863011 commit 74dad83
Show file tree
Hide file tree
Showing 9 changed files with 141 additions and 59 deletions.
1 change: 1 addition & 0 deletions core/ajax/Abeille.ajax.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,7 @@ function sendToCmd($topic, $payload = '') {
$e['since'] = '-';
else
$e['since'] = floor((time() - strtotime($e['lastComm'])) / 3600);
$e['noack'] = $eqLogic->getStatus('ab::noack', false);

// Last LQI
if ($eqAddr == "0000")
Expand Down
18 changes: 17 additions & 1 deletion core/class/Abeille.class.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1750,7 +1750,7 @@ public static function checkIfBatteryInfo($eqLogic, $attrName, $attrVal) {
}
}

/* Deal with messages coming from parser.
/* Deal with messages coming from parser or cmd processes.
Note: this is the new way to handle messages from parser, replacing progressively 'message()' */
public static function msgFromParser($msg) {
global $abQueues;
Expand All @@ -1772,6 +1772,22 @@ public static function msgFromParser($msg) {
return;
} // End 'newDevice'

/* Transmit status has changed. */
if ($msg['type'] == "eqTxStatusUpdate") {
log::add('Abeille', 'debug', "msgFromParser(): TX status update: ".$net.'/'.$addr.", status=".$msg['txStatus']);

$eqLogic = eqLogic::byLogicalId($net.'/'.$addr, 'Abeille');
if (is_object($eqLogic)) {
$noack = ($msg['txStatus'] == 'ok') ? false : true;
$eqLogic->setStatus('ab::noack', $noack);
$eqLogic->save();
} else {
log::add('Abeille', 'error', "msgFromParser(eqTxStatusUpdate): Equipement inconnu: ".$net.'/'.$addr);
}

return;
} // End 'eqTxStatusUpdate'

/* Parser has found device infos to update. */
if ($msg['type'] == "deviceUpdates") {
log::add('Abeille', 'debug', "msgFromParser(): ".$net.'/'.$addr.'/'.$ep.", Device updates, ".json_encode($msg, JSON_UNESCAPED_SLASHES));
Expand Down
69 changes: 50 additions & 19 deletions core/class/AbeilleCmdQueue.class.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ public function checkCmdToSendInTheQueue($priority) {
// }
// }

public function removeFirstCmdFromQueue($priority) {
if ($this->checkCmdToSendInTheQueue($priority))
array_shift($this->zigates[$this->zgId]['cmdQueue'][$priority]);
else
cmdLog("debug", __FUNCTION__." Trying to remove a cmd in an empty queue.");
}
// public function removeFirstCmdFromQueue($priority) {
// if ($this->checkCmdToSendInTheQueue($priority))
// array_shift($this->zigates[$this->zgId]['cmdQueue'][$priority]);
// else
// cmdLog("debug", __FUNCTION__." Trying to remove a cmd in an empty queue.");
// }

// public function zgGetQueue($priority) {
// return $this->zigates[$this->zgId]['cmdQueue'][$priority];
Expand Down Expand Up @@ -593,7 +593,7 @@ function processAcks() {
if (msg_receive($this->queueParserToCmdAck, 0, $msgType, $msgMax, $msgJson, false, MSG_IPC_NOWAIT, $errCode) == false) {
if ($errCode == 7) {
msg_receive($this->queueParserToCmdAck, 0, $msgType, $msgMax, $msgJson, false, MSG_IPC_NOWAIT | MSG_NOERROR);
logMessage('debug', 'processAcks() ERROR: msg TOO BIG ignored: '.$msgJson);
logMessage('error', 'processAcks() ERROR: msg TOO BIG ignored: '.$msgJson);
continue;
} else if ($errCode != 42) // 42 = No message
cmdLog("debug", "processAcks() ERROR: msg_receive() err ".$errCode);
Expand Down Expand Up @@ -643,7 +643,7 @@ function processAcks() {
continue;
}

// PDM restore response
// PDM restore response (Abeille's ABxx-yyyy specific FW)
if ($msg['type'] == "AB03") {
cmdLog("debug", " AB03 msg: ID=".$msg['id'].", Status=".$msg['status']);

Expand Down Expand Up @@ -736,8 +736,39 @@ function processAcks() {

// If ACK is requested but failed, removing cmd or it will lead to cmd timeout.
// Note: This is done only if cmd == last sent.
if ($cmd['ackAps'] && $lastSent)
// if ($cmd['ackAps'] && $lastSent)
// $removeCmd = true;
if ($lastSent && ($cmd['waitFor'] == "ACK")) {
$removeCmd = true;

$eqStatusChanged = '';
$net = $msg['net'];
$addr = $msg['addr'];
$eq = &getDevice($net, $addr); // By ref
if ($eq === false) {
cmdLog('error', " Unknown device: Net=${net} Addr=${addr}");
} else {
if ($msg['status'] == '00') { // Ok ?
if ($eq['txStatus'] != 'ok')
$eqStatusChanged = 'ok';
} else { // NO ACK ?
if ($eq['txStatus'] != 'noack')
$eqStatusChanged = 'noack';
}
if ($eqStatusChanged != '') {
$eq['txStatus'] = $eqStatusChanged;
$msg = array(
// 'src' => 'cmd',
'type' => 'eqTxStatusUpdate',
'net' => $net,
'addr' => $addr,
'txStatus' => $eqStatusChanged // 'ok', or 'noack'
);
msgToAbeille($msg);
cmdLog('debug', " ${net}-${addr} status changed to '${eqStatusChanged}'");
}
}
}
}

/* Tcharp38: 8702 now ignored. Just means message buffered but does not
Expand All @@ -762,16 +793,15 @@ function processAcks() {
// }

// Removing last sent cmd
if (isset($removeCmd)) {
if ($removeCmd) {
// cmdLog('debug', ' queue before='.json_encode($this->zgGetQueue($this->zgGetSentPri())));
if (isset($removeCmd) && $removeCmd) {
// cmdLog('debug', ' queue before='.json_encode($this->zgGetQueue($this->zgGetSentPri())));

cmdLog('debug', ' Removing cmd from queue');
$this->removeFirstCmdFromQueue($sentPri);
cmdLog('debug', ' Removing cmd from queue');
// $this->removeFirstCmdFromQueue($sentPri);
array_shift($this->zigates[$zgId]['cmdQueue'][$sentPri]);

// cmdLog('debug', ' queue after='.json_encode($this->zgGetQueue($this->zgGetSentPri())));
$this->zigates[$zgId]['available'] = 1; // Zigate is free again
}
// cmdLog('debug', ' queue after='.json_encode($this->zgGetQueue($this->zgGetSentPri())));
$this->zigates[$zgId]['available'] = 1; // Zigate is free again
}
}

Expand Down Expand Up @@ -804,8 +834,9 @@ function checkZigatesStatus() {
continue; // Timeout not reached yet

cmdLog("debug", "WARNING: checkZigatesStatus(): Zigate".$zgId." cmd ".$cmd['cmd']." ${timeout}s TIMEOUT (SQN=".$cmd['sqn'].", SQNAPS=".$cmd['sqnAps'].") => Considering zigate available.");
$this->zgId = $zgId;
$this->removeFirstCmdFromQueue($sentPri); // Removing blocked cmd
// $this->zgId = $zgId;
// $this->removeFirstCmdFromQueue($sentPri); // Removing blocked cmd
array_shift($this->zigates[$zgId]['cmdQueue'][$sentPri]);
$this->zigates[$zgId]['available'] = 1;
}
} // End checkZigatesStatus()
Expand Down
21 changes: 11 additions & 10 deletions core/class/AbeilleParser.class.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5735,16 +5735,17 @@ function decode8702($dest, $payload, $lqi) {
parserLog('debug', $dest.', Type='.$msgDecoded, "8702");

// Sending msg to cmd for flow control
$msg = array (
'type' => "8702",
'net' => $dest,
'status' => $status,
'addr' => $dstAddr,
'sqnAps' => $sqnAps,
'nPDU' => $nPdu,
'aPDU' => $aPdu,
);
$this->msgToCmdAck($msg);
// No longer used on cmd side
// $msg = array (
// 'type' => "8702",
// 'net' => $dest,
// 'status' => $status,
// 'addr' => $dstAddr,
// 'sqnAps' => $sqnAps,
// 'nPDU' => $nPdu,
// 'aPDU' => $aPdu,
// );
// $this->msgToCmdAck($msg);

// Monitor if requested
if (isset($GLOBALS["dbgMonitorAddr"]) && !strcasecmp($GLOBALS["dbgMonitorAddr"], $dstAddr))
Expand Down
4 changes: 3 additions & 1 deletion core/i18n/en_US.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,9 @@
"Adresse": "Address",
"Dernière comm.": "Last comm.",
"Depuis": "Since",
"Batterie": "Battery"
"Batterie": "Battery",
"Cliquez pour trier": "Click to sort",
"Désactivé": "Disabled"
},
"plugins/Abeille/desktop/modal/Abeille-OTA.modal.php": {
"Mise-à-jour des équipements": "Equipments update",
Expand Down
47 changes: 35 additions & 12 deletions core/php/AbeilleCmd.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,30 @@ function cmdLog($loglevel = 'NONE', $message = "", $isEnable = 1) {
logMessage($loglevel, $message);
}

/* Get device infos.
Returns: device entry by reference or false */
function &getDevice($net, $addr) {
if (!isset($GLOBALS['devices'][$net]))
return false;
if (!isset($GLOBALS['devices'][$net][$addr]))
return false;

return $GLOBALS['devices'][$net][$addr];
}

// Reread Jeedom useful infos on eqLogic DB update
// Note: A delay is required prior to this if DB has to be updated (createDevice() in Abeille.class)
function updateDeviceFromDB($eqId) {
$eqLogic = eqLogic::byId($eqId);
$eqLogicId = $eqLogic->getLogicalId();
list($net, $addr) = explode("/", $eqLogicId);

// $GLOBALS['eqList'][$net][$addr]['tuyaEF00'] = $eqLogic->getConfiguration('ab::tuyaEF00', null);
// parserLog('debug', " 'tuyaEF00' updated to ".json_encode($GLOBALS['eqList'][$net][$addr]['tuyaEF00']));
// $GLOBALS['eqList'][$net][$addr]['xiaomi'] = $eqLogic->getConfiguration('ab::xiaomi', null);
// parserLog('debug', " 'xiaomi' updated to ".json_encode($GLOBALS['eqList'][$net][$addr]['xiaomi']));
// $GLOBALS['eqList'][$net][$addr]['customization'] = $eqLogic->getConfiguration('ab::customization', null);
// parserLog('debug', " 'customization' updated to ".json_encode($GLOBALS['eqList'][$net][$addr]['customization']));
// $GLOBALS['devices'][$net][$addr]['tuyaEF00'] = $eqLogic->getConfiguration('ab::tuyaEF00', null);
// parserLog('debug', " 'tuyaEF00' updated to ".json_encode($GLOBALS['devices'][$net][$addr]['tuyaEF00']));
// $GLOBALS['devices'][$net][$addr]['xiaomi'] = $eqLogic->getConfiguration('ab::xiaomi', null);
// parserLog('debug', " 'xiaomi' updated to ".json_encode($GLOBALS['devices'][$net][$addr]['xiaomi']));
// $GLOBALS['devices'][$net][$addr]['customization'] = $eqLogic->getConfiguration('ab::customization', null);
// parserLog('debug', " 'customization' updated to ".json_encode($GLOBALS['devices'][$net][$addr]['customization']));
// TO BE COMPLETED if any other key info
}

Expand All @@ -52,7 +63,17 @@ function msgToCmd($msg) {

$queue = msg_get_queue($abQueues["xToCmd"]["id"]);
if (msg_send($queue, 1, json_encode($msg), false, false, $errCode) == false) {
parserLog("debug", "msgToCmd(): ERROR ".$errCode);
cmdLog("debug", "msgToCmd(): ERROR ".$errCode);
}
}

/* Send msg to Abeille ('xToAbeille' queue) */
function msgToAbeille($msg) {
global $abQueues;

$queue = msg_get_queue($abQueues["xToAbeille"]["id"]);
if (msg_send($queue, 1, json_encode($msg), false, false, $errCode) == false) {
cmdLog("debug", "msgToAbeille(): ERROR ".$errCode);
}
}

Expand Down Expand Up @@ -125,7 +146,7 @@ function configureDevice($net, $addr) {
// php AbeilleCmd.php debug
//check already running

$abeilleConfig = AbeilleTools::getParameters();
$abeilleConfig = AbeilleTools::getConfig();
$running = AbeilleTools::getRunningDaemons();
$daemons = AbeilleTools::diffExpectedRunningDaemons($abeilleConfig, $running);
logMessage('debug', 'Daemons status: '.json_encode($daemons));
Expand Down Expand Up @@ -193,11 +214,13 @@ function signalHandler($signal) {
if (!isset($GLOBALS['devices'][$net]))
$GLOBALS['devices'][$net] = [];

$eq = [];
$eq['ieee'] = $eqLogic->getConfiguration('IEEE', '');
$eqModel = $eqLogic->getConfiguration('ab::eqModel', []);
$eq['jsonId'] = isset($eqModel['id']) ? $eqModel['id'] : '';
$eq['jsonLocation'] = isset($eqModel['location']) ? $eqModel['location'] : 'Abeille';
$eq = array(
'ieee' => $eqLogic->getConfiguration('IEEE', ''),
'txStatus' => 'ok', // Transmit status: 'ok' or 'noack'
'jsonId' => isset($eqModel['id']) ? $eqModel['id'] : '',
'jsonLocation' => isset($eqModel['location']) ? $eqModel['location'] : 'Abeille',
);
if ($eq['jsonId'] != '') {
// Read JSON to get list of commands to execute
$model = AbeilleTools::getDeviceModel($eq['jsonId'], $eq['jsonLocation']);
Expand Down
2 changes: 1 addition & 1 deletion core/php/AbeilleParser.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ function updateDeviceFromDB($eqId) {
logMessage("info", ">>> Démarrage d'AbeilleParser");

// Check if already running
$config = AbeilleTools::getParameters();
$config = AbeilleTools::getConfig();
$running = AbeilleTools::getRunningDaemons();
$daemons= AbeilleTools::diffExpectedRunningDaemons($config, $running);
logMessage('debug', 'Daemons: '.json_encode($daemons));
Expand Down
36 changes: 21 additions & 15 deletions desktop/modal/AbeilleHealth.modal.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

$eqLogics = Abeille::byType('Abeille');
?>
Démons:
{{Démons}}:
<?php
function displayDaemonStatus($diff, $name, &$oneMissing) {
$nameLow = strtolower(substr($name, 0, 1)).substr($name, 1); // First char lower case
Expand Down Expand Up @@ -48,7 +48,7 @@ function displayDaemonStatus($diff, $name, &$oneMissing) {
echo " Attention: Un ou plusieurs démons ne tournent pas !";

/* Checking if active Zigates are not in timeout */
echo " Zigates: ";
echo " Zigates: ";
for ($zgId = 1; $zgId <= maxNbOfZigate; $zgId++) {
if ($config['ab::zgEnabled'.$zgId] != "Y")
continue; // Zigate disabled
Expand Down Expand Up @@ -78,16 +78,16 @@ function displayDaemonStatus($diff, $name, &$oneMissing) {
<table class="table table-condensed tablesorter" id="table_healthAbeille">
<thead>
<tr>
<th class="header" data-toggle="tooltip" title="Trier par">{{Réseau}}</th>
<th class="header" data-toggle="tooltip" title="Trier par">{{Equipement}}</th>
<th class="header" data-toggle="tooltip" title="Trier par">{{Type}}</th>
<th class="header" data-toggle="tooltip" title="Trier par">{{Adresse}}</th>
<th class="header" data-toggle="tooltip" title="Trier par">{{IEEE}}</th>
<th class="header" data-toggle="tooltip" title="Trier par">{{Status}}</th>
<th class="header" data-toggle="tooltip" title="Trier par">{{Dernière comm.}}</th>
<th class="header" data-toggle="tooltip" title="Trier par">{{Depuis}} (H)</th>
<th class="header" data-toggle="tooltip" title="Trier par dernier LQI">{{LQI}}</th>
<th class="header" data-toggle="tooltip" title="Trier par niveau batterie">{{Batterie}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{Réseau}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{Equipement}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{Type}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{Adresse}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{IEEE}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{Status}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{Dernière comm.}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{Depuis}} (H)</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{LQI}}</th>
<th class="header" data-toggle="tooltip" title="{{Cliquez pour trier}}">{{Batterie}}</th>
</tr>
</thead>
<tbody>
Expand Down Expand Up @@ -272,9 +272,15 @@ function refreshHealth() {
status = '<span class="label label-default" style="font-size: 1em; cursor: default;">{{Désactivé}}</span>';
else if (addr.substr(2) == "rc") // Remote control ?
status = '<span class="label label-success" style="font-size: 1em; cursor: default;">-</span>';
else if (e.timeout == 1)
status = '<span class="label label-danger" style="font-size: 1em; cursor: default;">{{Time-out}}</span>';
else
else if (e.timeout || e.noack) {
if (e.timeout && !e.noack)
s = "{{Time-out}}";
else if (!e.timeout && e.noack)
s = "{{No-ACK}}";
else
s = "{{Time-out}}&{{No-ACK}}";
status = '<span class="label label-danger" style="font-size: 1em; cursor: default;">' + s + '</span>';
} else
status = '<span class="label label-success" style="font-size: 1em; cursor: default;">{{OK}}</span>';
tr += '<td>'+status+'</td>';

Expand Down
2 changes: 2 additions & 0 deletions docs/fr_FR/Changelog.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ ChangeLog
=========

- Interne: Parser: Cluster FC00 traité par message 8002 pour future migration mode 'raw'.
- Interne: Ajout surveillance 'NOACK' en plus de 'Timeout'.
- Page santé: Status amélioré => 'Time-out', ''no-ack' ou 'time-out&no-ack'

230918-BETA-1
-------------
Expand Down

0 comments on commit 74dad83

Please sign in to comment.