pylint hints

Author: Marc Hofmann

.pylintrc

@@ -1,6 +1,6 @@
 [MAIN]
 max-line-length=140
-max-attributes=11
+max-attributes=15
 
 [DESIGN]
 max-statements=100

HINTS.md

@@ -80,11 +80,11 @@ This page describes implementation details.
 ## Dyscom commands
 
 ### Common
-- Strings are 1 byte less long (null termination is not an extra byte) in acknowledge packets
 - Datetime parameters have a different order
 
 ### DL_init
 - Init state seems always be UNUSED
+- Strings are 1 byte longer than in other commands
 - Output data rate depends on init params filter property
 - Setting a filter overwrite other settings
   - ADS129x register channel 1-4 settings

src/__main__.py

@@ -1,27 +1,19 @@
 """Test program how to use library without installing the library,
 DO NOT USE THIS FILE, USE EXAMPLES INSTEAD"""
 
-from timeit import default_timer as timer
-
 import logging
 import sys
 import asyncio
 
 from science_mode_4.device_i24 import DeviceI24
-from science_mode_4.device_p24 import DeviceP24
-from science_mode_4.dyscom.ads129x.ads129x_channel_settings_register import Ads129xChannelPowerMode
-from science_mode_4.dyscom.ads129x.ads129x_config_register_1 import Ads129xOutputDataRate, Ads129xPowerMode
-from science_mode_4.dyscom.dyscom_get_file_by_name import PacketDyscomGetAckFileByName, PacketDyscomGetFileByName
+from science_mode_4.dyscom.dyscom_get_file_by_name import PacketDyscomGetAckFileByName
 from science_mode_4.dyscom.dyscom_get_operation_mode import PacketDyscomGetAckOperationMode
 from science_mode_4.dyscom.dyscom_layer import LayerDyscom
 from science_mode_4.dyscom.dyscom_send_file import PacketDyscomSendFile
-from science_mode_4.dyscom.dyscom_send_live_data import PacketDyscomSendLiveData
-from science_mode_4.dyscom.dyscom_types import DyscomFilterType, DyscomGetType, DyscomInitFlag, DyscomInitParams, DyscomPowerModulePowerType, DyscomPowerModuleType, DyscomSignalType
+from science_mode_4.dyscom.dyscom_types import DyscomGetType
 from science_mode_4.protocol.commands import Commands
-from science_mode_4.protocol.types import ResultAndError
 from science_mode_4.utils import logger
 from science_mode_4.utils.serial_port_connection import SerialPortConnection
-from science_mode_4.utils.usb_connection import UsbConnection
 
 
 
@@ -70,18 +62,18 @@ async def main() -> int:
 
     # p = PacketDyscomGetFileByName(calibration_filename)
     # dyscom.send_packet(p)
-    get_file_by_name_ack = await dyscom.get_file_by_name(calibration_filename)
+    await dyscom.get_file_by_name(calibration_filename)
 
     # dyscom.send_send_file(get_file_by_name_ack.block_offset)
     # for x in range(get_file_by_name_ack.number_of_blocks):
     #     dyscom.send_send_file(get_file_by_name_ack.block_offset + x)
 
-    meas_info = await dyscom.get_file_info(init_ack.measurement_file_id)
-    await dyscom.get_operation_mode()
+    # meas_info = await dyscom.get_file_info(init_ack.measurement_file_id)
+    # await dyscom.get_operation_mode()
 
-    p = PacketDyscomGetFileByName(init_ack.measurement_file_id)
-    dyscom.send_packet(p)
-    dyscom.send_get_operation_mode()
+    # p = PacketDyscomGetFileByName(init_ack.measurement_file_id)
+    # dyscom.send_packet(p)
+    # dyscom.send_get_operation_mode()
     # get_file_by_name_ack = await dyscom.get_file_by_name(init_ack.measurement_file_id)
     # await dyscom.get_operation_mode()
 
@@ -96,6 +88,7 @@ async def main() -> int:
     return 0
 
 def process_ack(dyscom: LayerDyscom) -> int:
+    """Process all packets read from connection buffer"""
     offset = 0
     while True:
         # process all available packages
@@ -105,6 +98,7 @@ def process_ack(dyscom: LayerDyscom) -> int:
             if ack.command == Commands.DL_SEND_FILE:
                 send_file: PacketDyscomSendFile = ack
                 data = send_file.data
+                print(data)
             elif ack.command == Commands.DL_GET_ACK and ack.kind == DyscomGetType.OPERATION_MODE:
                 op_mode: PacketDyscomGetAckOperationMode = ack
                 print(op_mode.operation_mode.name)

src/science_mode_4/dyscom/dyscom_get_battery_status.py

@@ -3,7 +3,6 @@
 from typing import NamedTuple
 import struct
 
-from science_mode_4.protocol.commands import Commands
 from .dyscom_types import DyscomEnergyFlag, DyscomGetType
 from .dyscom_get import PacketDyscomGet, PacketDyscomGetAck
 
@@ -23,7 +22,6 @@ class PacketDyscomGetBatteryStatus(PacketDyscomGet):
 
     def __init__(self):
         super().__init__()
-        self._command = Commands.DL_GET
         self._type = DyscomGetType.BATTERY
         self._kind = int(self._type)
 

src/science_mode_4/dyscom/dyscom_get_device_id.py

@@ -1,6 +1,5 @@
 """Provides packet classes for dyscom get with type device id"""
 
-from science_mode_4.protocol.commands import Commands
 from .dyscom_types import DyscomGetType
 from .dyscom_helper import DyscomHelper
 from .dyscom_get import PacketDyscomGet, PacketDyscomGetAck
@@ -12,7 +11,6 @@ class PacketDyscomGetDeviceId(PacketDyscomGet):
 
     def __init__(self):
         super().__init__()
-        self._command = Commands.DL_GET
         self._type = DyscomGetType.DEVICE_ID
         self._kind = int(self._type)
 

src/science_mode_4/dyscom/dyscom_get_file_by_name.py

@@ -32,6 +32,8 @@ def get_data(self) -> bytes:
         bb = ByteBuilder()
         bb.append_bytes(super().get_data())
         bb.append_bytes(DyscomHelper.str_to_bytes(self._filename, 128))
+        # maybe more parameters are necessary here
+        # block_offset, file_size, n_blocks, mode
         return bb.get_bytes()
 
 

src/science_mode_4/dyscom/dyscom_get_file_info.py

@@ -2,7 +2,6 @@
 
 from typing import NamedTuple
 
-from science_mode_4.protocol.commands import Commands
 from science_mode_4.utils.byte_builder import ByteBuilder
 from .dyscom_types import DyscomGetType
 from .dyscom_helper import DyscomHelper
@@ -22,7 +21,6 @@ class PacketDyscomGetFileInfo(PacketDyscomGet):
 
     def __init__(self, filename: str = ""):
         super().__init__()
-        self._command = Commands.DL_GET
         self._type = DyscomGetType.FILE_INFO
         self._kind = int(self._type)
         self._filename = filename
@@ -32,6 +30,8 @@ def get_data(self) -> bytes:
         bb = ByteBuilder()
         bb.append_bytes(super().get_data())
         bb.append_bytes(DyscomHelper.str_to_bytes(self._filename, 128))
+        # maybe more parameters are necessary here
+        # file_size, file_checksum
         return bb.get_bytes()
 
 

src/science_mode_4/dyscom/dyscom_get_file_system_status.py

@@ -3,7 +3,6 @@
 # from dataclasses import dataclass
 
 from typing import NamedTuple
-from science_mode_4.protocol.commands import Commands
 from .dyscom_types import DyscomGetType
 from .dyscom_get import PacketDyscomGet, PacketDyscomGetAck
 
@@ -21,7 +20,6 @@ class PacketDyscomGetFileSystemStatus(PacketDyscomGet):
 
     def __init__(self):
         super().__init__()
-        self._command = Commands.DL_GET
         self._type = DyscomGetType.FILESYSTEM_STATUS
         self._kind = int(self._type)
 

src/science_mode_4/dyscom/dyscom_get_firmware_version.py

@@ -1,6 +1,5 @@
 """Provides packet classes for dyscom get with type firmware version"""
 
-from science_mode_4.protocol.commands import Commands
 from .dyscom_types import DyscomGetType
 from .dyscom_helper import DyscomHelper
 from .dyscom_get import PacketDyscomGet, PacketDyscomGetAck
@@ -12,7 +11,6 @@ class PacketDyscomGetFirmwareVersion(PacketDyscomGet):
 
     def __init__(self):
         super().__init__()
-        self._command = Commands.DL_GET
         self._type = DyscomGetType.FIRMWARE_VERSION
         self._kind = int(self._type)
 

src/science_mode_4/dyscom/dyscom_get_list_of_measurement_meta_info.py

@@ -1,6 +1,5 @@
 """Provides packet classes for dyscom get with type list of measurement meta info"""
 
-from science_mode_4.protocol.commands import Commands
 from .dyscom_types import DyscomGetType
 from .dyscom_get import PacketDyscomGet, PacketDyscomGetAck
 
@@ -11,7 +10,6 @@ class PacketDyscomGetListOfMeasurementMetaInfo(PacketDyscomGet):
 
     def __init__(self):
         super().__init__()
-        self._command = Commands.DL_GET
         self._type = DyscomGetType.LIST_OF_MEASUREMENT_META_INFO
         self._kind = int(self._type)