/* * Copyright (c) 2017 Shaun Feakes - All rights reserved * * You may use redistribute and/or modify this code under the terms of * the GNU General Public License version 2 as published by the * Free Software Foundation. For the terms of this license, * see . * * You are free to use this software under the terms of the GNU General * Public License, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. * * https://github.com/sfeakes/aqualinkd */ #include #include "devices_jandy.h" #include "aq_serial.h" #include "aqualink.h" #include "utils.h" #include "aq_mqtt.h" #include "packetLogger.h" /* All button errors 'Check AQUAPURE No Flow' 'Check AQUAPURE Low Salt' 'Check AQUAPURE High Salt' 'Check AQUAPURE General Fault' */ static int _swg_noreply_cnt = 0; bool processJandyPacket(unsigned char *packet_buffer, int packet_length, struct aqualinkdata *aqdata) { static rsDeviceType interestedInNextAck = DRS_NONE; static unsigned char previous_packet_to = NUL; // bad name, it's not previous, it's previous that we were interested in. int rtn = false; // We received the ack from a Jandy device we are interested in if (packet_buffer[PKT_DEST] == DEV_MASTER && interestedInNextAck != DRS_NONE) { if (interestedInNextAck == DRS_SWG) { rtn = processPacketFromSWG(packet_buffer, packet_length, aqdata); } else if (interestedInNextAck == DRS_EPUMP) { rtn = processPacketFromJandyPump(packet_buffer, packet_length, aqdata); } interestedInNextAck = DRS_NONE; previous_packet_to = NUL; } // We were expecting an ack from Jandy device but didn't receive it. else if (packet_buffer[PKT_DEST] != DEV_MASTER && interestedInNextAck != DRS_NONE) { if (interestedInNextAck == DRS_SWG && aqdata->ar_swg_device_status != SWG_STATUS_OFF) { // SWG Offline processMissingAckPacketFromSWG(previous_packet_to, aqdata); } else if (interestedInNextAck == DRS_EPUMP) { // ePump offline processMissingAckPacketFromJandyPump(previous_packet_to, aqdata); } interestedInNextAck = DRS_NONE; previous_packet_to = NUL; } else if (READ_RSDEV_SWG && packet_buffer[PKT_DEST] == SWG_DEV_ID) { interestedInNextAck = DRS_SWG; rtn = processPacketToSWG(packet_buffer, packet_length, aqdata, _aqconfig_.swg_zero_ignore); previous_packet_to = packet_buffer[PKT_DEST]; } else if (READ_RSDEV_ePUMP && packet_buffer[PKT_DEST] >= JANDY_DEC_PUMP_MIN && packet_buffer[PKT_DEST] <= JANDY_DEC_PUMP_MAX) { interestedInNextAck = DRS_EPUMP; rtn = processPacketToJandyPump(packet_buffer, packet_length, aqdata); previous_packet_to = packet_buffer[PKT_DEST]; } else { interestedInNextAck = DRS_NONE; previous_packet_to = NUL; } return rtn; } bool processPacketToSWG(unsigned char *packet, int packet_length, struct aqualinkdata *aqdata, int swg_zero_ignore) { static int swg_zero_cnt = 0; bool changedAnything = false; // Only read message from controller to SWG to set SWG Percent if we are not programming, as we might be changing this if (packet[3] == CMD_PERCENT && aqdata->active_thread.thread_id == 0 && packet[4] != 0xFF) { // In service or timeout mode SWG set % message is very strange. AR %% | HEX: 0x10|0x02|0x50|0x11|0xff|0x72|0x10|0x03| // Not really sure what to do with this, just ignore 0xff / 255 for the moment. (if statment above) // SWG can get ~10 messages to set to 0 then go back again for some reason, so don't go to 0 until 10 messages are received if (swg_zero_cnt <= swg_zero_ignore && packet[4] == 0x00) { LOG(DJAN_LOG, LOG_DEBUG, "Ignoring SWG set to %d due to packet packet count %d <= %d from control panel to SWG 0x%02hhx 0x%02hhx\n", (int)packet[4], swg_zero_cnt, swg_zero_ignore, packet[4], packet[5]); swg_zero_cnt++; } else if (swg_zero_cnt > swg_zero_ignore && packet[4] == 0x00) { if (aqdata->swg_percent != (int)packet[4]) { //aqdata->swg_percent = (int)packet[4]; setSWGpercent(aqdata, (int)packet[4]); changedAnything = true; aqdata->updated = true; LOG(DJAN_LOG, LOG_DEBUG, "Set SWG %% to %d from reading control panel packet sent to SWG (received %d messages)\n", aqdata->swg_percent, swg_zero_cnt); } // LOG(DJAN_LOG, LOG_DEBUG, "SWG set to %d due to packet packet count %d <= %d from control panel to SWG 0x%02hhx 0x%02hhx\n", // (int)packet[4],swg_zero_cnt,SWG_ZERO_IGNORE_COUNT,packet[4],packet[5]); swg_zero_cnt++; } else { swg_zero_cnt = 0; if (aqdata->swg_percent != (int)packet[4]) { //aqdata->swg_percent = (int)packet[4]; setSWGpercent(aqdata, (int)packet[4]); changedAnything = true; aqdata->updated = true; LOG(DJAN_LOG, LOG_DEBUG, "Set SWG %% to %d from control panel packet to SWG\n", aqdata->swg_percent); } // LOG(DJAN_LOG, LOG_DEBUG, "SWG set to %d due to packet from control panel to SWG 0x%02hhx 0x%02hhx\n", // aqdata.swg_percent,packet[4],packet[5]); } if (aqdata->swg_percent > 100) aqdata->boost = true; else aqdata->boost = false; } return changedAnything; } bool processPacketFromSWG(unsigned char *packet, int packet_length, struct aqualinkdata *aqdata) { bool changedAnything = false; _swg_noreply_cnt = 0; if (packet[PKT_CMD] == CMD_PPM) { //aqdata->ar_swg_device_status = packet[5]; setSWGdeviceStatus(aqdata, JANDY_DEVICE, packet[5]); if (aqdata->swg_delayed_percent != TEMP_UNKNOWN && aqdata->ar_swg_device_status == SWG_STATUS_ON) { // We have a delayed % to set. char sval[10]; snprintf(sval, 9, "%d", aqdata->swg_delayed_percent); aq_programmer(AQ_SET_SWG_PERCENT, sval, aqdata); LOG(DJAN_LOG, LOG_NOTICE, "Setting SWG %% to %d, from delayed message\n", aqdata->swg_delayed_percent); aqdata->swg_delayed_percent = TEMP_UNKNOWN; } if ( (packet[4] * 100) != aqdata->swg_ppm ) { aqdata->swg_ppm = packet[4] * 100; LOG(DJAN_LOG, LOG_DEBUG, "Set SWG PPM to %d from SWG packet\n", aqdata->swg_ppm); changedAnything = true; aqdata->updated = true; } // logMessage(LOG_DEBUG, "Read SWG PPM %d from ID 0x%02hhx\n", aqdata.swg_ppm, SWG_DEV_ID); } return changedAnything; } void processMissingAckPacketFromSWG(unsigned char destination, struct aqualinkdata *aqdata) { // SWG_STATUS_UNKNOWN means we have never seen anything from SWG, so leave as is. // IAQTOUCH & ONETOUCH give us AQUAPURE=0 but ALLBUTTON doesn't, so only turn off if we are not in extra device mode. // NSF Need to check that we actually use 0 from IAQTOUCH & ONETOUCH if ( aqdata->ar_swg_device_status != SWG_STATUS_UNKNOWN && isIAQT_ENABLED == false && isONET_ENABLED == false ) { if ( _swg_noreply_cnt < 3 ) { //_aqualink_data.ar_swg_device_status = SWG_STATUS_OFF; //_aqualink_data.updated = true; setSWGoff(aqdata); _swg_noreply_cnt++; // Don't put in if, as it'll go past size limit } } } bool isSWGDeviceErrorState(unsigned char status) { if (status == SWG_STATUS_NO_FLOW || status == SWG_STATUS_CHECK_PCB || status == SWG_STATUS_LOW_TEMP || status == SWG_STATUS_HIGH_CURRENT || status == SWG_STATUS_NO_FLOW) return true; else return false; } void setSWGdeviceStatus(struct aqualinkdata *aqdata, emulation_type requester, unsigned char status) { if (aqdata->ar_swg_device_status == status) return; // If we get (ALLBUTTON, SWG_STATUS_CHECK_PCB), it sends this for many status, like clean cell. // So if we are in one of those states, don't use it. if (requester == ALLBUTTON && status == SWG_STATUS_CHECK_PCB ) { if (aqdata->ar_swg_device_status > SWG_STATUS_ON && aqdata->ar_swg_device_status < SWG_STATUS_TURNING_OFF) { LOG(DJAN_LOG, LOG_DEBUG, "Ignoreing set SWG device state to '0x%02hhx', request from %d\n", aqdata->ar_swg_device_status, requester); return; } } // Check validity of status and set as appropiate switch (status) { case SWG_STATUS_ON: case SWG_STATUS_NO_FLOW: case SWG_STATUS_LOW_SALT: case SWG_STATUS_HI_SALT: case SWG_STATUS_HIGH_CURRENT: case SWG_STATUS_CLEAN_CELL: case SWG_STATUS_LOW_VOLTS: case SWG_STATUS_LOW_TEMP: case SWG_STATUS_CHECK_PCB: aqdata->ar_swg_device_status = status; aqdata->swg_led_state = isSWGDeviceErrorState(status)?ENABLE:ON; break; case SWG_STATUS_OFF: // THIS IS OUR OFF STATUS, NOT AQUAPURE case SWG_STATUS_TURNING_OFF: aqdata->ar_swg_device_status = status; aqdata->swg_led_state = OFF; break; default: LOG(DJAN_LOG, LOG_WARNING, "Ignoring set SWG device to state '0x%02hhx', state is unknown\n", status); return; break; } LOG(DJAN_LOG, LOG_DEBUG, "Set SWG device state to '0x%02hhx', request from %d, LED state = %d\n", aqdata->ar_swg_device_status, requester, aqdata->swg_led_state); } /* bool updateSWG(struct aqualinkdata *aqdata, emulation_type requester, aqledstate state, int percent) { switch (requester) { case ALLBUTTON: // no insight into 0% (just blank) break; case ONETOUCH: break; case IAQTOUCH: break; case AQUAPDA: break; case JANDY_DEVICE: break; } } */ bool setSWGboost(struct aqualinkdata *aqdata, bool on) { if (!on) { aqdata->boost = false; aqdata->boost_msg[0] = '\0'; aqdata->swg_percent = 0; } else { aqdata->boost = true; aqdata->swg_percent = 101; } return true; } // Only change SWG percent if we are not in SWG programming bool changeSWGpercent(struct aqualinkdata *aqdata, int percent) { if (in_swg_programming_mode(aqdata)) { LOG(DJAN_LOG, LOG_DEBUG, "Ignoring set SWG %% to %d due to programming SWG\n", aqdata->swg_percent); return false; } setSWGpercent(aqdata, percent); return true; } void setSWGoff(struct aqualinkdata *aqdata) { if (aqdata->ar_swg_device_status != SWG_STATUS_OFF || aqdata->swg_led_state != OFF) aqdata->updated = true; aqdata->ar_swg_device_status = SWG_STATUS_OFF; aqdata->swg_led_state = OFF; LOG(DJAN_LOG, LOG_DEBUG, "Set SWG to off\n"); } void setSWGenabled(struct aqualinkdata *aqdata) { if (aqdata->swg_led_state != ENABLE) { aqdata->updated = true; aqdata->swg_led_state = ENABLE; LOG(DJAN_LOG, LOG_DEBUG, "Set SWG to Enable\n"); } } // force a Change SWG percent. void setSWGpercent(struct aqualinkdata *aqdata, int percent) { aqdata->swg_percent = percent; aqdata->updated = true; if (aqdata->swg_percent > 0) { //LOG(DJAN_LOG, LOG_DEBUG, "swg_led_state=%d, swg_led_state=%d, isSWGDeviceErrorState=%d, ar_swg_device_status=%d\n",aqdata->swg_led_state, aqdata->swg_led_state, isSWGDeviceErrorState(aqdata->ar_swg_device_status),aqdata->ar_swg_device_status); if (aqdata->swg_led_state == OFF || (aqdata->swg_led_state == ENABLE && ! isSWGDeviceErrorState(aqdata->ar_swg_device_status)) ) // Don't change ENABLE / FLASH aqdata->swg_led_state = ON; if (aqdata->ar_swg_device_status == SWG_STATUS_UNKNOWN) aqdata->ar_swg_device_status = SWG_STATUS_ON; } if ( aqdata->swg_percent == 0 ) { if (aqdata->swg_led_state == ON) aqdata->swg_led_state = ENABLE; // Don't change OFF if (aqdata->ar_swg_device_status == SWG_STATUS_UNKNOWN) aqdata->ar_swg_device_status = SWG_STATUS_ON; // Maybe this should be off } LOG(DJAN_LOG, LOG_DEBUG, "Set SWG %% to %d, LED=%d, FullStatus=0x%02hhx\n", aqdata->swg_percent, aqdata->swg_led_state, aqdata->ar_swg_device_status); } aqledstate get_swg_led_state(struct aqualinkdata *aqdata) { switch (aqdata->ar_swg_device_status) { case SWG_STATUS_ON: return (aqdata->swg_percent > 0?ON:ENABLE); break; case SWG_STATUS_NO_FLOW: return ENABLE; break; case SWG_STATUS_LOW_SALT: return (aqdata->swg_percent > 0?ON:ENABLE); break; case SWG_STATUS_HI_SALT: return (aqdata->swg_percent > 0?ON:ENABLE); break; case SWG_STATUS_HIGH_CURRENT: return (aqdata->swg_percent > 0?ON:ENABLE); break; case SWG_STATUS_TURNING_OFF: return OFF; break; case SWG_STATUS_CLEAN_CELL: return (aqdata->swg_percent > 0?ON:ENABLE); return ENABLE; break; case SWG_STATUS_LOW_VOLTS: return ENABLE; break; case SWG_STATUS_LOW_TEMP: return ENABLE; break; case SWG_STATUS_CHECK_PCB: return ENABLE; break; case SWG_STATUS_OFF: // THIS IS OUR OFF STATUS, NOT AQUAPURE return OFF; break; default: return (aqdata->swg_percent > 0?ON:ENABLE); break; } } void get_swg_status_msg(struct aqualinkdata *aqdata, char *message) { int tmp1; int tmp2; return get_swg_status_mqtt(aqdata, message, &tmp1, &tmp2); } void get_swg_status_mqtt(struct aqualinkdata *aqdata, char *message, int *status, int *dzalert) { switch (aqdata->ar_swg_device_status) { // Level = (0=gray, 1=green, 2=yellow, 3=orange, 4=red) case SWG_STATUS_ON: *status = (aqdata->swg_percent > 0?SWG_ON:SWG_OFF); sprintf(message, "AQUAPURE GENERATING CHLORINE"); *dzalert = 1; break; case SWG_STATUS_NO_FLOW: *status = SWG_OFF; sprintf(message, "AQUAPURE NO FLOW"); *dzalert = 2; break; case SWG_STATUS_LOW_SALT: *status = (aqdata->swg_percent > 0?SWG_ON:SWG_OFF); sprintf(message, "AQUAPURE LOW SALT"); *dzalert = 2; break; case SWG_STATUS_HI_SALT: *status = (aqdata->swg_percent > 0?SWG_ON:SWG_OFF); sprintf(message, "AQUAPURE HIGH SALT"); *dzalert = 3; break; case SWG_STATUS_HIGH_CURRENT: *status = (aqdata->swg_percent > 0?SWG_ON:SWG_OFF); sprintf(message, "AQUAPURE HIGH CURRENT"); *dzalert = 4; break; case SWG_STATUS_TURNING_OFF: *status = SWG_OFF; sprintf(message, "AQUAPURE TURNING OFF"); *dzalert = 0; break; case SWG_STATUS_CLEAN_CELL: *status = (aqdata->swg_percent > 0?SWG_ON:SWG_OFF); sprintf(message, "AQUAPURE CLEAN CELL"); *dzalert = 2; break; case SWG_STATUS_LOW_VOLTS: *status = (aqdata->swg_percent > 0?SWG_ON:SWG_OFF); sprintf(message, "AQUAPURE LOW VOLTAGE"); *dzalert = 3; break; case SWG_STATUS_LOW_TEMP: *status = SWG_OFF; sprintf(message, "AQUAPURE WATER TEMP LOW"); *dzalert = 2; break; case SWG_STATUS_CHECK_PCB: *status = SWG_OFF; sprintf(message, "AQUAPURE CHECK PCB"); *dzalert = 4; break; case SWG_STATUS_OFF: // THIS IS OUR OFF STATUS, NOT AQUAPURE *status = SWG_OFF; sprintf(message, "AQUAPURE OFF"); *dzalert = 0; break; default: *status = (aqdata->swg_percent > 0?SWG_ON:SWG_OFF); sprintf(message, "AQUAPURE UNKNOWN STATUS"); *dzalert = 4; break; } } bool processPacketToJandyPump(unsigned char *packet_buffer, int packet_length, struct aqualinkdata *aqdata) { char msg[1000]; //logMessage(LOG_DEBUG, "Need to log ePump message here for future\n"); beautifyPacket(msg, packet_buffer, packet_length, true); LOG(DJAN_LOG, LOG_DEBUG, "To ePump: %s\n", msg); //find pump for message if ( 1 == 0 /*SOME_DEBUG_TEST*/) { int i; for (i=0; i < aqdata->num_pumps; i++) { if (aqdata->pumps[i].pumpID == packet_buffer[PKT_DEST]) { LOG(DJAN_LOG, LOG_DEBUG, "Last panel info RPM:%d GPM:%d WATTS:%d\n", aqdata->pumps[i].rpm, aqdata->pumps[i].gpm, aqdata->pumps[i].watts); break; } } } return false; } bool processPacketFromJandyPump(unsigned char *packet_buffer, int packet_length, struct aqualinkdata *aqdata) { char msg[1000]; //logMessage(LOG_DEBUG, "Need to log ePump message here for future\n"); beautifyPacket(msg, packet_buffer, packet_length, true); LOG(DJAN_LOG, LOG_DEBUG, "From ePump: %s\n", msg); return false; } void processMissingAckPacketFromJandyPump(unsigned char destination, struct aqualinkdata *aqdata) { // Do nothing for the moment. return; } /* Messages to ePump so far. Debug: To ePump: Jandy Packet | HEX: 0x10|0x02|0x78|0x42|0xcc|0x10|0x03| Debug: To ePump: Jandy Packet | HEX: 0x10|0x02|0x78|0x44|0x00|0x10|0x27|0x05|0x10|0x03| Debug: To ePump: Jandy Packet | HEX: 0x10|0x02|0x78|0x44|0x00|0x58|0x1b|0x41|0x10|0x03| Debug: To ePump: Jandy Packet | HEX: 0x10|0x02|0x78|0x45|0x00|0x05|0xd4|0x10|0x03| Debug: To ePump: Jandy Packet | HEX: 0x10|0x02|0x78|0x46|0x00|0x00|0x03|0xd3|0x10|0x03| Debug: To ePump: Jandy Packet | HEX: 0x10|0x02|0x78|0x46|0x00|0x04|0x00|0xd4|0x10|0x03| */