1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard.

     6

# This files implements the bacnet plugin for Beremiz, adding BACnet server support.

     7

#

     8

# Copyright (C) 2017: Mario de Sousa (msousa@fe.up.pt)

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

# This program is free software; you can redistribute it and/or

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

# of the License, or (at your option) any later version.

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

# You should have received a copy of the GNU General Public License

    23

# along with this program; if not, write to the Free Software

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

import wx

    27

from collections        import Counter

    28

from pickle             import dump

    29

from util.BitmapLibrary import GetBitmap

    30

    31

    32

    33

# Import some libraries on Beremiz code...

    34

from controls.CustomGrid        import CustomGrid

    35

from controls.CustomTable       import CustomTable

    36

from editors.ConfTreeNodeEditor import ConfTreeNodeEditor

    37

from graphics.GraphicCommons    import ERROR_HIGHLIGHT

    38

    39

    40

    41

# BACnet Engineering units taken from: ASHRAE 135-2016, clause/chapter 21

    42

BACnetEngineeringUnits = [ 

    43

    ('(Acceleration) meters-per-second-per-second (166)',              166   ),

    44

    ('(Area) square-meters (0)',                                       0     ),

    45

    ('(Area) square-centimeters (116)',                                116   ),

    46

    ('(Area) square-feet (1)',                                         1     ),

    47

    ('(Area) square-inches (115)',                                     115   ),

    48

    ('(Currency) currency1 (105)',                                     105   ),

    49

    ('(Currency) currency2 (106)',                                     106   ),

    50

    ('(Currency) currency3 (107)',                                     107   ),

    51

    ('(Currency) currency4 (108)',                                     108   ),

    52

    ('(Currency) currency5 (109)',                                     109   ),

    53

    ('(Currency) currency6 (110)',                                     110   ),

    54

    ('(Currency) currency7 (111)',                                     111   ),

    55

    ('(Currency) currency8 (112)',                                     112   ),

    56

    ('(Currency) currency9 (113)',                                     113   ),

    57

    ('(Currency) currency10 (114)',                                    114   ),

    58

    ('(Electrical) milliamperes (2)',                                  2     ),

    59

    ('(Electrical) amperes (3)',                                       3     ),

    60

    ('(Electrical) amperes-per-meter (167)',                           167   ),

    61

    ('(Electrical) amperes-per-square-meter (168)',                    168   ),

    62

    ('(Electrical) ampere-square-meters (169)',                        169   ),

    63

    ('(Electrical) decibels (199)',                                    199   ),

    64

    ('(Electrical) decibels-millivolt (200)',                          200   ),

    65

    ('(Electrical) decibels-volt (201)',                               201   ),

    66

    ('(Electrical) farads (170)',                                      170   ),

    67

    ('(Electrical) henrys (171)',                                      171   ),

    68

    ('(Electrical) ohms (4)',                                          4     ),

    69

    ('(Electrical) ohm-meter-squared-per-meter (237)',                 237   ),

    70

    ('(Electrical) ohm-meters (172)',                                  172   ),

    71

    ('(Electrical) milliohms (145)',                                   145   ),

    72

    ('(Electrical) kilohms (122)',                                     122   ),

    73

    ('(Electrical) megohms (123)',                                     123   ),

    74

    ('(Electrical) microsiemens (190)',                                190   ),

    75

    ('(Electrical) millisiemens (202)',                                202   ),

    76

    ('(Electrical) siemens (173)',                                     173   ),

    77

    ('(Electrical) siemens-per-meter (174)',                           174   ),

    78

    ('(Electrical) teslas (175)',                                      175   ),

    79

    ('(Electrical) volts (5)',                                         5     ),

    80

    ('(Electrical) millivolts (124)',                                  124   ),

    81

    ('(Electrical) kilovolts (6)',                                     6     ),

    82

    ('(Electrical) megavolts (7)',                                     7     ),

    83

    ('(Electrical) volt-amperes (8)',                                  8     ),

    84

    ('(Electrical) kilovolt-amperes (9)',                              9     ),

    85

    ('(Electrical) megavolt-amperes (10)',                             10    ),

    86

    ('(Electrical) volt-amperes-reactive (11)',                        11    ),

    87

    ('(Electrical) kilovolt-amperes-reactive (12)',                    12    ),

    88

    ('(Electrical) megavolt-amperes-reactive (13)',                    13    ),

    89

    ('(Electrical) volts-per-degree-kelvin (176)',                     176   ),

    90

    ('(Electrical) volts-per-meter (177)',                             177   ),

    91

    ('(Electrical) degrees-phase (14)',                                14    ),

    92

    ('(Electrical) power-factor (15)',                                 15    ),

    93

    ('(Electrical) webers (178)',                                      178   ),

    94

    ('(Energy) ampere-seconds (238)',                                  238   ),

    95

    ('(Energy) volt-ampere-hours (239)',                               239   ),

    96

    ('(Energy) kilovolt-ampere-hours (240)',                           240   ),

    97

    ('(Energy) megavolt-ampere-hours (241)',                           241   ),

    98

    ('(Energy) volt-ampere-hours-reactive (242)',                      242   ),

    99

    ('(Energy) kilovolt-ampere-hours-reactive (243)',                  243   ),

   100

    ('(Energy) megavolt-ampere-hours-reactive (244)',                  244   ),

   101

    ('(Energy) volt-square-hours (245)',                               245   ),

   102

    ('(Energy) ampere-square-hours (246)',                             246   ),

   103

    ('(Energy) joules (16)',                                           16    ),

   104

    ('(Energy) kilojoules (17)',                                       17    ),

   105

    ('(Energy) kilojoules-per-kilogram (125)',                         125   ),

   106

    ('(Energy) megajoules (126)',                                      126   ),

   107

    ('(Energy) watt-hours (18)',                                       18    ),

   108

    ('(Energy) kilowatt-hours (19)',                                   19    ),

   109

    ('(Energy) megawatt-hours (146)',                                  146   ),

   110

    ('(Energy) watt-hours-reactive (203)',                             203   ),

   111

    ('(Energy) kilowatt-hours-reactive (204)',                         204   ),

   112

    ('(Energy) megawatt-hours-reactive (205)',                         205   ),

   113

    ('(Energy) btus (20)',                                             20    ),

   114

    ('(Energy) kilo-btus (147)',                                       147   ),

   115

    ('(Energy) mega-btus (148)',                                       148   ),

   116

    ('(Energy) therms (21)',                                           21    ),

   117

    ('(Energy) ton-hours (22)',                                        22    ),

   118

    ('(Enthalpy) joules-per-kilogram-dry-air (23)',                    23    ),

   119

    ('(Enthalpy) kilojoules-per-kilogram-dry-air (149)',               149   ),

   120

    ('(Enthalpy) megajoules-per-kilogram-dry-air (150)',               150   ),

   121

    ('(Enthalpy) btus-per-pound-dry-air (24)',                         24    ),

   122

    ('(Enthalpy) btus-per-pound (117)',                                117   ),

   123

    ('(Entropy) joules-per-degree-kelvin (127)',                       127   ),

   124

    ('(Entropy) kilojoules-per-degree-kelvin (151)',                   151   ),

   125

    ('(Entropy) megajoules-per-degree-kelvin (152)',                   152   ),

   126

    ('(Entropy) joules-per-kilogram-degree-kelvin (128)',              128   ),

   127

    ('(Force) newton (153)',                                           153   ),

   128

    ('(Frequency) cycles-per-hour (25)',                               25    ),

   129

    ('(Frequency) cycles-per-minute (26)',                             26    ),

   130

    ('(Frequency) hertz (27)',                                         27    ),

   131

    ('(Frequency) kilohertz (129)',                                    129   ),

   132

    ('(Frequency) megahertz (130)',                                    130   ),

   133

    ('(Frequency) per-hour (131)',                                     131   ),

   134

    ('(Humidity) grams-of-water-per-kilogram-dry-air (28)',            28    ),

   135

    ('(Humidity) percent-relative-humidity (29)',                      29    ),

   136

    ('(Length) micrometers (194)',                                     194   ),

   137

    ('(Length) millimeters (30)',                                      30    ),

   138

    ('(Length) centimeters (118)',                                     118   ),

   139

    ('(Length) kilometers (193)',                                      193   ),

   140

    ('(Length) meters (31)',                                           31    ),

   141

    ('(Length) inches (32)',                                           32    ),

   142

    ('(Length) feet (33)',                                             33    ),

   143

    ('(Light) candelas (179)',                                         179   ),

   144

    ('(Light) candelas-per-square-meter (180)',                        180   ),

   145

    ('(Light) watts-per-square-foot (34)',                             34    ),

   146

    ('(Light) watts-per-square-meter (35)',                            35    ),

   147

    ('(Light) lumens (36)',                                            36    ),

   148

    ('(Light) luxes (37)',                                             37    ),

   149

    ('(Light) foot-candles (38)',                                      38    ),

   150

    ('(Mass) milligrams (196)',                                        196   ),

   151

    ('(Mass) grams (195)',                                             195   ),

   152

    ('(Mass) kilograms (39)',                                          39    ),

   153

    ('(Mass) pounds-mass (40)',                                        40    ),

   154

    ('(Mass) tons (41)',                                               41    ),

   155

    ('(Mass Flow) grams-per-second (154)',                             154   ),

   156

    ('(Mass Flow) grams-per-minute (155)',                             155   ),

   157

    ('(Mass Flow) kilograms-per-second (42)',                          42    ),

   158

    ('(Mass Flow) kilograms-per-minute (43)',                          43    ),

   159

    ('(Mass Flow) kilograms-per-hour (44)',                            44    ),

   160

    ('(Mass Flow) pounds-mass-per-second (119)',                       119   ),

   161

    ('(Mass Flow) pounds-mass-per-minute (45)',                        45    ),

   162

    ('(Mass Flow) pounds-mass-per-hour (46)',                          46    ),

   163

    ('(Mass Flow) tons-per-hour (156)',                                156   ),

   164

    ('(Power) milliwatts (132)',                                       132   ),

   165

    ('(Power) watts (47)',                                             47    ),

   166

    ('(Power) kilowatts (48)',                                         48    ),

   167

    ('(Power) megawatts (49)',                                         49    ),

   168

    ('(Power) btus-per-hour (50)',                                     50    ),

   169

    ('(Power) kilo-btus-per-hour (157)',                               157   ),

   170

    ('(Power) joule-per-hours (247)',                                  247   ),

   171

    ('(Power) horsepower (51)',                                        51    ),

   172

    ('(Power) tons-refrigeration (52)',                                52    ),

   173

    ('(Pressure) pascals (53)',                                        53    ),

   174

    ('(Pressure) hectopascals (133)',                                  133   ),

   175

    ('(Pressure) kilopascals (54)',                                    54    ),

   176

    ('(Pressure) millibars (134)',                                     134   ),

   177

    ('(Pressure) bars (55)',                                           55    ),

   178

    ('(Pressure) pounds-force-per-square-inch (56)',                   56    ),

   179

    ('(Pressure) millimeters-of-water (206)',                          206   ),

   180

    ('(Pressure) centimeters-of-water (57)',                           57    ),

   181

    ('(Pressure) inches-of-water (58)',                                58    ),

   182

    ('(Pressure) millimeters-of-mercury (59)',                         59    ),

   183

    ('(Pressure) centimeters-of-mercury (60)',                         60    ),

   184

    ('(Pressure) inches-of-mercury (61)',                              61    ),

   185

    ('(Temperature) degrees-celsius (62)',                             62    ),

   186

    ('(Temperature) degrees-kelvin (63)',                              63    ),

   187

    ('(Temperature) degrees-kelvin-per-hour (181)',                    181   ),

   188

    ('(Temperature) degrees-kelvin-per-minute (182)',                  182   ),

   189

    ('(Temperature) degrees-fahrenheit (64)',                          64    ),

   190

    ('(Temperature) degree-days-celsius (65)',                         65    ),

   191

    ('(Temperature) degree-days-fahrenheit (66)',                      66    ),

   192

    ('(Temperature) delta-degrees-fahrenheit (120)',                   120   ),

   193

    ('(Temperature) delta-degrees-kelvin (121)',                       121   ),

   194

    ('(Time) years (67)',                                              67    ),

   195

    ('(Time) months (68)',                                             68    ),

   196

    ('(Time) weeks (69)',                                              69    ),

   197

    ('(Time) days (70)',                                               70    ),

   198

    ('(Time) hours (71)',                                              71    ),

   199

    ('(Time) minutes (72)',                                            72    ),

   200

    ('(Time) seconds (73)',                                            73    ),

   201

    ('(Time) hundredths-seconds (158)',                                158   ),

   202

    ('(Time) milliseconds (159)',                                      159   ),

   203

    ('(Torque) newton-meters (160)',                                   160   ),

   204

    ('(Velocity) millimeters-per-second (161)',                        161   ),

   205

    ('(Velocity) millimeters-per-minute (162)',                        162   ),

   206

    ('(Velocity) meters-per-second (74)',                              74    ),

   207

    ('(Velocity) meters-per-minute (163)',                             163   ),

   208

    ('(Velocity) meters-per-hour (164)',                               164   ), 

   209

    ('(Velocity) kilometers-per-hour (75)',                            75    ), 

   210

    ('(Velocity) feet-per-second (76)',                                76    ), 

   211

    ('(Velocity) feet-per-minute (77)',                                77    ), 

   212

    ('(Velocity) miles-per-hour (78)',                                 78    ), 

   213

    ('(Volume) cubic-feet (79)',                                       79    ), 

   214

    ('(Volume) cubic-meters (80)',                                     80    ), 

   215

    ('(Volume) imperial-gallons (81)',                                 81    ), 

   216

    ('(Volume) milliliters (197)',                                     197   ), 

   217

    ('(Volume) liters (82)',                                           82    ), 

   218

    ('(Volume) us-gallons (83)',                                       83    ), 

   219

    ('(Volumetric Flow) cubic-feet-per-second (142)',                  142   ), 

   220

    ('(Volumetric Flow) cubic-feet-per-minute (84)',                   84    ), 

   221

    ('(Volumetric Flow) million-standard-cubic-feet-per-minute (254)', 254   ), 

   222

    ('(Volumetric Flow) cubic-feet-per-hour (191)',                    191   ), 

   223

    ('(Volumetric Flow) cubic-feet-per-day (248)',                     248   ), 

   224

    ('(Volumetric Flow) standard-cubic-feet-per-day (47808)',          47808 ), 

   225

    ('(Volumetric Flow) million-standard-cubic-feet-per-day (47809)',  47809 ), 

   226

    ('(Volumetric Flow) thousand-cubic-feet-per-day (47810)',          47810 ), 

   227

    ('(Volumetric Flow) thousand-standard-cubic-feet-per-day (47811)', 47811 ), 

   228

    ('(Volumetric Flow) pounds-mass-per-day (47812)',                  47812 ), 

   229

    ('(Volumetric Flow) cubic-meters-per-second (85)',                 85    ), 

   230

    ('(Volumetric Flow) cubic-meters-per-minute (165)',                165   ), 

   231

    ('(Volumetric Flow) cubic-meters-per-hour (135)',                  135   ), 

   232

    ('(Volumetric Flow) cubic-meters-per-day (249)',                   249   ), 

   233

    ('(Volumetric Flow) imperial-gallons-per-minute (86)',             86    ), 

   234

    ('(Volumetric Flow) milliliters-per-second (198)',                 198   ), 

   235

    ('(Volumetric Flow) liters-per-second (87)',                       87    ), 

   236

    ('(Volumetric Flow) liters-per-minute (88)',                       88    ), 

   237

    ('(Volumetric Flow) liters-per-hour (136)',                        136   ), 

   238

    ('(Volumetric Flow) us-gallons-per-minute (89)',                   89    ), 

   239

    ('(Volumetric Flow) us-gallons-per-hour (192)',                    192   ), 

   240

    ('(Other) degrees-angular (90)',                                   90    ), 

   241

    ('(Other) degrees-celsius-per-hour (91)',                          91    ), 

   242

    ('(Other) degrees-celsius-per-minute (92)',                        92    ), 

   243

    ('(Other) degrees-fahrenheit-per-hour (93)',                       93    ), 

   244

    ('(Other) degrees-fahrenheit-per-minute (94)',                     94    ), 

   245

    ('(Other) joule-seconds (183)',                                    183   ), 

   246

    ('(Other) kilograms-per-cubic-meter (186)',                        186   ), 

   247

    ('(Other) kilowatt-hours-per-square-meter (137)',                  137   ), 

   248

    ('(Other) kilowatt-hours-per-square-foot (138)',                   138   ), 

   249

    ('(Other) watt-hours-per-cubic-meter (250)',                       250   ), 

   250

    ('(Other) joules-per-cubic-meter (251)',                           251   ), 

   251

    ('(Other) megajoules-per-square-meter (139)',                      139   ), 

   252

    ('(Other) megajoules-per-square-foot (140)',                       140   ), 

   253

    ('(Other) mole-percent (252)',                                     252   ), 

   254

    ('(Other) no-units (95)',                                          95    ), 

   255

    ('(Other) newton-seconds (187)',                                   187   ), 

   256

    ('(Other) newtons-per-meter (188)',                                188   ), 

   257

    ('(Other) parts-per-million (96)',                                 96    ), 

   258

    ('(Other) parts-per-billion (97)',                                 97    ), 

   259

    ('(Other) pascal-seconds (253)',                                   253   ), 

   260

    ('(Other) percent (98)',                                           98    ), 

   261

    ('(Other) percent-obscuration-per-foot (143)',                     143   ), 

   262

    ('(Other) percent-obscuration-per-meter (144)',                    144   ), 

   263

    ('(Other) percent-per-second (99)',                                99    ), 

   264

    ('(Other) per-minute (100)',                                       100   ), 

   265

    ('(Other) per-second (101)',                                       101   ), 

   266

    ('(Other) psi-per-degree-fahrenheit (102)',                        102   ), 

   267

    ('(Other) radians (103)',                                          103   ), 

   268

    ('(Other) radians-per-second (184)',                               184   ), 

   269

    ('(Other) revolutions-per-minute (104)',                           104   ), 

   270

    ('(Other) square-meters-per-newton (185)',                         185   ), 

   271

    ('(Other) watts-per-meter-per-degree-kelvin (189)',                189   ), 

   272

    ('(Other) watts-per-square-meter-degree-kelvin (141)',             141   ), 

   273

    ('(Other) per-mille (207)',                                        207   ), 

   274

    ('(Other) grams-per-gram (208)',                                   208   ), 

   275

    ('(Other) kilograms-per-kilogram (209)',                           209   ), 

   276

    ('(Other) grams-per-kilogram (210)',                               210   ), 

   277

    ('(Other) milligrams-per-gram (211)',                              211   ), 

   278

    ('(Other) milligrams-per-kilogram (212)',                          212   ), 

   279

    ('(Other) grams-per-milliliter (213)',                             213   ), 

   280

    ('(Other) grams-per-liter (214)',                                  214   ), 

   281

    ('(Other) milligrams-per-liter (215)',                             215   ), 

   282

    ('(Other) micrograms-per-liter (216)',                             216   ), 

   283

    ('(Other) grams-per-cubic-meter (217)',                            217   ), 

   284

    ('(Other) milligrams-per-cubic-meter (218)',                       218   ), 

   285

    ('(Other) micrograms-per-cubic-meter (219)',                       219   ), 

   286

    ('(Other) nanograms-per-cubic-meter (220)',                        220   ), 

   287

    ('(Other) grams-per-cubic-centimeter (221)',                       221   ), 

   288

    ('(Other) becquerels (222)',                                       222   ), 

   289

    ('(Other) kilobecquerels (223)',                                   223   ), 

   290

    ('(Other) megabecquerels (224)',                                   224   ), 

   291

    ('(Other) gray (225)',                                             225   ), 

   292

    ('(Other) milligray (226)',                                        226   ), 

   293

    ('(Other) microgray (227)',                                        227   ), 

   294

    ('(Other) sieverts (228)',                                         228   ), 

   295

    ('(Other) millisieverts (229)',                                    229   ), 

   296

    ('(Other) microsieverts (230)',                                    230   ), 

   297

    ('(Other) microsieverts-per-hour (231)',                           231   ), 

   298

    ('(Other) millirems (47814)',                                      47814 ), 

   299

    ('(Other) millirems-per-hour (47815)',                             47815 ), 

   300

    ('(Other) decibels-a (232)',                                       232   ), 

   301

    ('(Other) nephelometric-turbidity-unit (233)',                     233   ), 

   302

    ('(Other) pH (234)',                                               234   ), 

   303

    ('(Other) grams-per-square-meter (235)',                           235   ), 

   304

    ('(Other) minutes-per-degree-kelvin (236)',                        236   )  

   305

    ] # BACnetEngineeringUnits 

   306

   307

   308

   309

# ObjectID (22 bits ID + 10 bits type) => max = 2^22-1 = 4194303

   310

#  However, ObjectID 4194303 is not allowed!

   311

#  4194303 is used as a special value when object Id reference is referencing an undefined object 

   312

#  (similar to NULL in C)

   313

BACnetObjectID_MAX = 4194302

   314

BACnetObjectID_NUL = 4194303

   315

   316

   317

   318

# A base class

   319

# what would be a purely virtual class in C++

   320

class ObjectProperties:

   321

    # this __init_() function is currently not beeing used!

   322

    def __init__(self):

   323

        #nothing to do 

   324

        return

   325

   326

   327

class BinaryObject(ObjectProperties):

   328

    # 'PropertyNames' will be used as the header for each column of the Object Properties grid! 

   329

    # Warning: The rest of the code depends on the existance of an "Object Identifier" and "Object Name" 

   330

    #          Be sure to use these exact names for these BACnet object properties!

   331

    PropertyNames    = ["Object Identifier", "Object Name", "Description"]

   332

    ColumnAlignments = [   wx.ALIGN_RIGHT  , wx.ALIGN_LEFT, wx.ALIGN_LEFT]

   333

    ColumnSizes      = [        40         ,      80      ,      80      ]

   334

    PropertyConfig   = {"Object Identifier": {"GridCellEditor"  : wx.grid.GridCellNumberEditor,

   335

                                              "GridCellRenderer"   : wx.grid.GridCellNumberRenderer,

   336

                                              "GridCellEditorParam": "0,4194302" 

   337

                                                                     # syntax for GridCellNumberEditor -> "min,max" 

   338

                                                                     # ObjectID (22 bits ID + 10 bits type) => max = 2^22-1 

   339

                                             },

   340

                        "Object Name"      : {"GridCellEditor"  : wx.grid.GridCellTextEditor,

   341

                                              "GridCellRenderer": wx.grid.GridCellStringRenderer},  

   342

                        "Description"      : {"GridCellEditor"  : wx.grid.GridCellTextEditor,

   343

                                              "GridCellRenderer": wx.grid.GridCellStringRenderer}

   344

                       }

   345

   346

class AnalogObject(ObjectProperties):

   347

    # 'PropertyNames' will be used as the header for each column of the Object Properties grid! 

   348

    # Warning: The rest of the code depends on the existance of an "Object Identifier" and "Object Name" 

   349

    #          Be sure to use these exact names for these BACnet object properties!

   350

    #

   351

    # NOTE: Although it is not listed here (so it does not show up in the GUI, this object will also

   352

    #       keep another entry for a virtual property named "Unit ID". This virtual property

   353

    #       will store the ID corresponding to the "Engineering Units" currently chosen.

   354

    #       This virtual property is kept synchronised to the "Engineering Units" property

   355

    #       by the function PropertyChanged() which should be called by the OnCellChange event handler.

   356

    PropertyNames    = ["Object Identifier", "Object Name", "Description", "Engineering Units"] #'Unit ID'

   357

    ColumnAlignments = [   wx.ALIGN_RIGHT  , wx.ALIGN_LEFT, wx.ALIGN_LEFT,    wx.ALIGN_LEFT   ]

   358

    ColumnSizes      = [        40         ,      80      ,      80      ,         200        ]

   359

    PropertyConfig   = {"Object Identifier": {"GridCellEditor"     : wx.grid.GridCellNumberEditor,

   360

                                              "GridCellRenderer"   : wx.grid.GridCellNumberRenderer,

   361

                                              "GridCellEditorParam": "0,4194302"

   362

                                                                     # syntax for GridCellNumberEditor -> "min,max" 

   363

                                                                     # ObjectID (22 bits ID + 10 bits type) => max = 2^22-1 

   364

                                             },

   365

                        "Object Name"      : {"GridCellEditor"     : wx.grid.GridCellTextEditor,

   366

                                              "GridCellRenderer"   : wx.grid.GridCellStringRenderer},  

   367

                        "Description"      : {"GridCellEditor"     : wx.grid.GridCellTextEditor,

   368

                                              "GridCellRenderer"   : wx.grid.GridCellStringRenderer},  

   369

                        "Engineering Units": {"GridCellEditor"     : wx.grid.GridCellChoiceEditor,

   370

                                              "GridCellRenderer"   : wx.grid.GridCellStringRenderer,  

   371

                                                                     # use string renderer with choice editor!

   372

                                              "GridCellEditorParam": ','.join([x[0] for x in BACnetEngineeringUnits]) 

   373

                                                                     # syntax for GridCellChoiceEditor -> comma separated values 

   374

                                              }  

   375

                       }

   376

   377

    # obj_properties should be a dictionary, with keys "Object Identifier", "Object Name", "Description", ...

   378

    def UpdateVirtualProperties(self, obj_properties):

   379

        obj_properties["Unit ID"] = [x[1] for x in BACnetEngineeringUnits if x[0] == obj_properties["Engineering Units"]][0]

   380

   381

   382

   383

class MultiSObject(ObjectProperties):

   384

    # 'PropertyNames' will be used as the header for each column of the Object Properties grid! 

   385

    # Warning: The rest of the code depends on the existance of an "Object Identifier" and "Object Name" 

   386

    #          Be sure to use these exact names for these BACnet object properties!

   387

    PropertyNames    = ["Object Identifier", "Object Name", "Description", "Number of States"]

   388

    ColumnAlignments = [   wx.ALIGN_RIGHT  , wx.ALIGN_LEFT, wx.ALIGN_LEFT,   wx.ALIGN_CENTER ]

   389

    ColumnSizes      = [        40         ,      80      ,      80      ,         120       ]

   390

    PropertyConfig   = {"Object Identifier": {"GridCellEditor"     : wx.grid.GridCellNumberEditor,

   391

                                              "GridCellRenderer"   : wx.grid.GridCellNumberRenderer,

   392

                                              "GridCellEditorParam": "0,4194302"

   393

                                                                     # syntax for GridCellNumberEditor -> "min,max" 

   394

                                                                     # ObjectID (22 bits ID + 10 bits type) => max = 2^22-1 

   395

                                             },

   396

                        "Object Name"      : {"GridCellEditor"     : wx.grid.GridCellTextEditor,

   397

                                              "GridCellRenderer"   : wx.grid.GridCellStringRenderer},  

   398

                        "Description"      : {"GridCellEditor"     : wx.grid.GridCellTextEditor,

   399

                                              "GridCellRenderer"   : wx.grid.GridCellStringRenderer},  

   400

                        "Number of States" : {"GridCellEditor"     : wx.grid.GridCellNumberEditor,

   401

                                              "GridCellRenderer"   : wx.grid.GridCellNumberRenderer,

   402

                                              "GridCellEditorParam": "1,255" # syntax for GridCellNumberEditor -> "min,max" 

   403

                                                                             # MultiState Values are encoded in unsigned integer

   404

                                                                             # (in BACnet => uint8_t), and can not be 0.

   405

                                                                             # See ASHRAE 135-2016, section 12.20.4

   406

                                             }

   407

                       }

   408

   409

   410

   411

# The default values to use for each BACnet object type

   412

#

   413

# Note that the 'internal plugin parameters' get stored in the data table, but

   414

# are not visible in the GUI. They are used to generate the 

   415

# EDE files as well as the C code

   416

class BVObject(BinaryObject):

   417

    DefaultValues    = {"Object Identifier":"",

   418

                        "Object Name"      :"Binary Value", 

   419

                        "Description"      :"",

   420

                        # internal plugin parameters...

   421

                        "BACnetObjTypeID"  :5,

   422

                        "Ctype"            :"uint8_t",

   423

                        "Settable"         :"Y"

   424

                        }

   425

   426

class BOObject(BinaryObject):

   427

    DefaultValues    = {"Object Identifier":"",

   428

                        "Object Name"      :"Binary Output", 

   429

                        "Description"      :"",

   430

                        # internal plugin parameters...

   431

                        "BACnetObjTypeID"  :4,

   432

                        "Ctype"            :"uint8_t",

   433

                        "Settable"         :"Y"

   434

                        }

   435

   436

class BIObject(BinaryObject):

   437

    DefaultValues    = {"Object Identifier":"",

   438

                        "Object Name"      :"Binary Input", 

   439

                        "Description"      :"",

   440

                        # internal plugin parameters...

   441

                        "BACnetObjTypeID"  :3,

   442

                        "Ctype"            :"uint8_t",

   443

                        "Settable"         :"N"

   444

                        }

   445

   446

class AVObject(AnalogObject):

   447

    DefaultValues    = {"Object Identifier":"", 

   448

                        "Object Name"      :"Analog Value",

   449

                        "Description"      :"", 

   450

                        "Engineering Units":'(Other) no-units (95)',

   451

                        # internal plugin parameters...

   452

                        "Unit ID"          :95,   # the ID of the engineering unit

   453

                                                  # will get updated by UpdateVirtualProperties()

   454

                        "BACnetObjTypeID"  :2,

   455

                        "Ctype"            :"float",

   456

                        "Settable"         :"Y"

   457

                        }

   458

   459

class AOObject(AnalogObject):

   460

    DefaultValues    = {"Object Identifier":"", 

   461

                        "Object Name"      :"Analog Output",

   462

                        "Description"      :"", 

   463

                        "Engineering Units":'(Other) no-units (95)',

   464

                        # internal plugin parameters...

   465

                        "Unit ID"          :95,   # the ID of the engineering unit

   466

                                                  # will get updated by UpdateVirtualProperties()

   467

                        "BACnetObjTypeID"  :1,

   468

                        "Ctype"            :"float",

   469

                        "Settable"         :"Y"

   470

                        }

   471

   472

class AIObject(AnalogObject):

   473

    DefaultValues    = {"Object Identifier":"", 

   474

                        "Object Name"      :"Analog Input",

   475

                        "Description"      :"", 

   476

                        "Engineering Units":'(Other) no-units (95)',

   477

                        # internal plugin parameters...

   478

                        "Unit ID"          :95,   # the ID of the engineering unit

   479

                                                  # will get updated by UpdateVirtualProperties()

   480

                        "BACnetObjTypeID"  :0,

   481

                        "Ctype"            :"float",

   482

                        "Settable"         :"N"

   483

                        }

   484

   485

class MSVObject(MultiSObject):

   486

    DefaultValues    = {"Object Identifier":"",

   487

                        "Object Name"      :"Multi-state Value",

   488

                        "Description"      :"",

   489

                        "Number of States" :"255",

   490

                        # internal plugin parameters...

   491

                        "BACnetObjTypeID"  :19,

   492

                        "Ctype"            :"uint8_t",

   493

                        "Settable"         :"Y"

   494

                        }

   495

   496

class MSOObject(MultiSObject):

   497

    DefaultValues    = {"Object Identifier":"",

   498

                        "Object Name"      :"Multi-state Output",

   499

                        "Description"      :"",

   500

                        "Number of States" :"255",

   501

                        # internal plugin parameters...

   502

                        "BACnetObjTypeID"  :14,

   503

                        "Ctype"            :"uint8_t",

   504

                        "Settable"         :"Y"

   505

                        }

   506

   507

class MSIObject(MultiSObject):

   508

    DefaultValues    = {"Object Identifier":"",

   509

                        "Object Name"      :"Multi-state Input",

   510

                        "Description"      :"",

   511

                        "Number of States" :"255",

   512

                        # internal plugin parameters...

   513

                        "BACnetObjTypeID"  :13,

   514

                        "Ctype"            :"uint8_t",

   515

                        "Settable"         :"N"

   516

                        }

   517

   518

   519

   520

   521

   522

   523

   524

   525

   526

   527

class ObjectTable(CustomTable):

   528

    #  A custom wx.grid.PyGridTableBase using user supplied data

   529

    #  

   530

    #  This will basically store a list of BACnet objects that the slave will support/implement.