summaryrefslogtreecommitdiffstats
path: root/plugin/ucs2-vol/inc/device_value.h
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/ucs2-vol/inc/device_value.h')
-rw-r--r--plugin/ucs2-vol/inc/device_value.h101
1 files changed, 101 insertions, 0 deletions
diff --git a/plugin/ucs2-vol/inc/device_value.h b/plugin/ucs2-vol/inc/device_value.h
new file mode 100644
index 0000000..fe6d3a5
--- /dev/null
+++ b/plugin/ucs2-vol/inc/device_value.h
@@ -0,0 +1,101 @@
+/*
+ * libmostvolume example
+ *
+ * Copyright (C) 2017 Microchip Technology Germany II GmbH & Co. KG
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You may also obtain this software under a propriety license from Microchip.
+ * Please contact Microchip for further information.
+ *
+ */
+
+#ifndef DEVICEVALUE_H
+#define DEVICEVALUE_H
+
+#include <stdint.h>
+#include "libmostvolume.h"
+
+struct SRxMessage {
+ uint32_t devInst; /*instance if multiple devices are using the same group id*/
+ uint32_t sourceAddr;
+ uint32_t targetAddr;
+ uint32_t nFBlock;
+ uint32_t nInst;
+ uint32_t nFunc;
+ uint32_t nOpType;
+ const uint8_t *pPayload;
+ uint32_t payloadLen;
+};
+
+struct STxMessage {
+ uint32_t devInst; /*instance if multiple devices are using the same group id*/
+ uint32_t targetAddr;
+ uint32_t nFBlock;
+ uint32_t nInst;
+ uint32_t nFunc;
+ uint32_t nOpType;
+ const uint8_t *pPayload;
+ uint32_t payloadLen;
+};
+
+enum DeviceValueType {
+ DEVICE_VAL_MASTER = 0,
+ DEVICE_VAL_LEFT = 1,
+ DEVICE_VAL_RIGHT = 2
+
+};
+
+class CDeviceValue {
+public:
+ CDeviceValue(uint16_t address, DeviceValueType type, uint16_t key);
+ virtual ~CDeviceValue();
+
+ uint16_t GetKey(){return _key;}
+ DeviceValueType GetType(){return _type;} // returns the assigned type
+ void SetValue(uint8_t value){_target_value = value;} // sets desired value
+
+ bool RequiresUpdate(); // returns true if target is not actual value
+ // returns true if success, false if failed
+ // -> stop transmission
+ bool FireUpdateMessage(lib_most_volume_writei2c_cb_t writei2c_fptr,
+ lib_most_volume_writei2c_result_cb_t result_fptr,
+ void *result_user_ptr);// fires message & updates actual value
+
+ void SetAvailable(bool active){this->_is_available = active; _actual_value = 0x01u;}
+ bool IsAvailable() {return this->_is_available;}
+ uint16_t GetAddress() {return this->_address;}
+
+private:
+ void ApplyMostValue(uint8_t value, DeviceValueType type, uint8_t tx_payload[]);
+ void HandleI2cResult(uint8_t result);
+ static void OnI2cResult(uint8_t result, void *obj_ptr);
+
+ bool _is_available; // related node is available
+ bool _is_busy; // do not update while busy
+ DeviceValueType _type; // determines the remote i2c command
+ uint16_t _key; // lookup key
+ uint16_t _address; // target node/group address
+ uint8_t _target_value; // desired value
+ uint8_t _transmitted_value;// value pending during transmission
+ uint8_t _actual_value; // value set and confirmed via network
+ uint8_t _tx_payload[20];
+ uint8_t _tx_payload_sz;
+
+ lib_most_volume_writei2c_result_cb_t _result_fptr;
+ void *_result_user_ptr;
+};
+
+#endif /* DEVICEPROPERTY_H */
+