fix a funcion name, add example usage (gijzelaerr#226)

nikteliy · web-flow · commit 282fdf2a55ed · 2020-12-15T15:23:42.000+01:00
diff --git a/example/write_multi.py b/example/write_multi.py
@@ -0,0 +1,53 @@
+import ctypes
+import snap7
+from snap7.types import S7WLByte, S7DataItem, S7WLWord, S7WLReal, S7WLTimer
+from snap7.types import areas, wordlen_to_ctypes
+from snap7.util import set_int, set_real, set_word, get_int, get_real, get_s5time
+
+
+client = snap7.client.Client()
+client.connect('192.168.100.100', 0, 2)
+
+items = []
+
+
+def set_data_item(area, word_len, db_number: int, start: int, amount: int, data: bytearray) -> S7DataItem:
+    item = S7DataItem()
+    item.Area = ctypes.c_int32(area)
+    item.WordLen = ctypes.c_int32(word_len)
+    item.DBNumber = ctypes.c_int32(db_number)
+    item.Start = ctypes.c_int32(start)
+    item.Amount = ctypes.c_int32(amount)
+    array_class = ctypes.c_uint8 * len(data)
+    cdata = array_class.from_buffer_copy(data)
+    item.pData = ctypes.cast(cdata, ctypes.POINTER(array_class)).contents
+    return item
+
+
+int_values = [10, 20, 30, 40]
+ints = bytearray(len(int_values) * 2)
+for i, value in enumerate(int_values):
+    set_int(ints, i * 2, value)
+
+real = bytearray(4)
+set_real(real, 0, 42.5)
+
+counters = 0x2999.to_bytes(2, 'big') + 0x1111.to_bytes(2, 'big')
+
+item1 = set_data_item(area=areas.DB, word_len=S7WLWord, db_number=1, start=0, amount=4, data=ints)
+item2 = set_data_item(area=areas.DB, word_len=S7WLReal, db_number=1, start=8, amount=1, data=real)
+item3 = set_data_item(area=areas.TM, word_len=S7WLTimer, db_number=0, start=2, amount=2, data=counters)
+
+items.append(item1)
+items.append(item2)
+items.append(item3)
+
+client.write_multi_vars(items)
+
+db_int = client.db_read(1, 0, 8)
+db_real = client.db_read(1, 8, 12)
+db_counters = client.ct_read(2, 2)
+
+print(f'int values: {[get_int(db_int, i * 2) for i in range(4)]}')
+print(f'real value: {get_real(db_real, 0)}')
+print(f'counters: {get_s5time(counters, 0)}, {get_s5time(counters, 2)}')
diff --git a/snap7/client.py b/snap7/client.py
@@ -909,7 +909,7 @@ def tm_write(self, start: int, amount: int, data: bytearray) -> int:
         check_error(result)
         return result
 
-    def writemultivars(self, items: List[S7DataItem]) -> int:
+    def write_multi_vars(self, items: List[S7DataItem]) -> int:
         # Cli_WriteMultiVars
         items_count = c_int32(len(items))
         data = bytearray()
diff --git a/test/test_client.py b/test/test_client.py
@@ -872,7 +872,7 @@ def test_tmw_rite(self):
         self.assertRaises(Snap7Exception, self.client.tm_write, 0, 100, bytes(200))
         self.assertRaises(ValueError, self.client.tm_write, 0, 2, bytes(2))
 
-    def test_writemultivars(self):
+    def test_write_multi_vars(self):
         # Cli_WriteMultiVars
         items_count = 3
         items = []
@@ -891,7 +891,7 @@ def test_writemultivars(self):
             item.pData = ctypes.cast(cdata, ctypes.POINTER(array_class)).contents
             items.append(item)
             expected_list.append(data)
-        result = self.client.writemultivars(items)
+        result = self.client.write_multi_vars(items)
         self.assertEqual(0, result)
         self.assertEqual(expected_list[0], self.client.db_read(db_number=1, start=0, size=4))
         self.assertEqual(expected_list[1], self.client.ct_read(0, 2))
