Hardware/TBalancer/TBalancer.cs
author moel.mich
Sun, 08 Aug 2010 13:57:26 +0000
changeset 165 813d8bc3192f
parent 137 9ed52fa44ecf
child 166 fa9dfbfc4145
permissions -rw-r--r--
Refactored the hardware monitoring code into a library (Issue 101).
moel@1
     1
/*
moel@1
     2
  
moel@1
     3
  Version: MPL 1.1/GPL 2.0/LGPL 2.1
moel@1
     4
moel@1
     5
  The contents of this file are subject to the Mozilla Public License Version
moel@1
     6
  1.1 (the "License"); you may not use this file except in compliance with
moel@1
     7
  the License. You may obtain a copy of the License at
moel@1
     8
 
moel@1
     9
  http://www.mozilla.org/MPL/
moel@1
    10
moel@1
    11
  Software distributed under the License is distributed on an "AS IS" basis,
moel@1
    12
  WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
moel@1
    13
  for the specific language governing rights and limitations under the License.
moel@1
    14
moel@1
    15
  The Original Code is the Open Hardware Monitor code.
moel@1
    16
moel@1
    17
  The Initial Developer of the Original Code is 
moel@1
    18
  Michael Möller <m.moeller@gmx.ch>.
moel@1
    19
  Portions created by the Initial Developer are Copyright (C) 2009-2010
moel@1
    20
  the Initial Developer. All Rights Reserved.
moel@1
    21
moel@1
    22
  Contributor(s):
moel@1
    23
moel@1
    24
  Alternatively, the contents of this file may be used under the terms of
moel@1
    25
  either the GNU General Public License Version 2 or later (the "GPL"), or
moel@1
    26
  the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
moel@1
    27
  in which case the provisions of the GPL or the LGPL are applicable instead
moel@1
    28
  of those above. If you wish to allow use of your version of this file only
moel@1
    29
  under the terms of either the GPL or the LGPL, and not to allow others to
moel@1
    30
  use your version of this file under the terms of the MPL, indicate your
moel@1
    31
  decision by deleting the provisions above and replace them with the notice
moel@1
    32
  and other provisions required by the GPL or the LGPL. If you do not delete
moel@1
    33
  the provisions above, a recipient may use your version of this file under
moel@1
    34
  the terms of any one of the MPL, the GPL or the LGPL.
moel@1
    35
 
moel@1
    36
*/
moel@1
    37
moel@1
    38
using System;
moel@1
    39
using System.Collections.Generic;
moel@1
    40
using System.Configuration;
moel@1
    41
using System.Text;
moel@1
    42
moel@1
    43
namespace OpenHardwareMonitor.Hardware.TBalancer {
moel@165
    44
  internal class TBalancer : IHardware {
moel@1
    45
moel@165
    46
    private ISettings settings;
moel@87
    47
    private int portIndex;
moel@87
    48
    private FT_HANDLE handle;
moel@33
    49
    private byte protocolVersion;
moel@1
    50
    private Sensor[] digitalTemperatures = new Sensor[8];
moel@1
    51
    private Sensor[] analogTemperatures = new Sensor[4];
moel@57
    52
    private Sensor[] sensorhubTemperatures = new Sensor[6];
moel@57
    53
    private Sensor[] sensorhubFlows = new Sensor[2];
moel@1
    54
    private Sensor[] fans = new Sensor[4];
moel@118
    55
    private Sensor[] controls = new Sensor[4];
moel@57
    56
    private Sensor[] miniNGTemperatures = new Sensor[4];
moel@57
    57
    private Sensor[] miniNGFans = new Sensor[4];
moel@137
    58
    private Sensor[] miniNGControls = new Sensor[4];
moel@1
    59
    private List<ISensor> active = new List<ISensor>();
moel@1
    60
    private List<ISensor> deactivating = new List<ISensor>();
moel@57
    61
    private int[] primaryData = new int[0];
moel@57
    62
    private int[] alternativeData = new int[0];
moel@1
    63
moel@1
    64
    public const byte STARTFLAG = 100;
moel@57
    65
    public const byte ENDFLAG = 254;
moel@57
    66
moel@57
    67
    private delegate void MethodDelegate();
moel@57
    68
    private MethodDelegate alternativeRequest;    
moel@1
    69
moel@165
    70
    public TBalancer(int portIndex, byte protocolVersion, ISettings settings) {
moel@165
    71
      this.settings = settings;
moel@165
    72
moel@87
    73
      this.portIndex = portIndex;
moel@33
    74
      this.protocolVersion = protocolVersion;
moel@1
    75
moel@63
    76
      ParameterDescription[] parameter = new ParameterDescription[] {
moel@122
    77
        new ParameterDescription("Offset [°C]", "Temperature offset.", 0)
moel@63
    78
      };
moel@57
    79
      int offset = 0;
moel@57
    80
      for (int i = 0; i < digitalTemperatures.Length; i++)
moel@88
    81
        digitalTemperatures[i] = new Sensor("Digital Sensor " + i,
moel@165
    82
          offset + i, SensorType.Temperature, this, parameter, settings);
moel@57
    83
      offset += digitalTemperatures.Length;
moel@57
    84
moel@57
    85
      for (int i = 0; i < analogTemperatures.Length; i++)
moel@88
    86
        analogTemperatures[i] = new Sensor("Analog Sensor " + (i + 1),
moel@165
    87
          offset + i, SensorType.Temperature, this, parameter, settings);
moel@57
    88
      offset += analogTemperatures.Length;
moel@57
    89
moel@57
    90
      for (int i = 0; i < sensorhubTemperatures.Length; i++)
moel@88
    91
        sensorhubTemperatures[i] = new Sensor("Sensorhub Sensor " + i,
moel@165
    92
          offset + i, SensorType.Temperature, this, parameter, settings);
moel@57
    93
      offset += sensorhubTemperatures.Length;
moel@57
    94
moel@57
    95
      for (int i = 0; i < miniNGTemperatures.Length; i++)
moel@63
    96
        miniNGTemperatures[i] = new Sensor("miniNG #" + (i / 2 + 1) +
moel@165
    97
          " Sensor " + (i % 2 + 1), offset + i, SensorType.Temperature,
moel@165
    98
          this, parameter, settings);
moel@57
    99
      offset += miniNGTemperatures.Length;
moel@57
   100
moel@118
   101
      for (int i = 0; i < sensorhubFlows.Length; i++)
moel@118
   102
        sensorhubFlows[i] = new Sensor("Flowmeter " + (i + 1),
moel@134
   103
          i, SensorType.Flow, this, new ParameterDescription[] {
moel@118
   104
            new ParameterDescription("Impulse Rate", 
moel@118
   105
              "The impulse rate of the flowmeter in pulses/L", 509)
moel@165
   106
          }, settings);
moel@118
   107
moel@118
   108
      for (int i = 0; i < controls.Length; i++) {
moel@137
   109
        controls[i] = new Sensor("Fan Channel " + i, i, SensorType.Control, 
moel@165
   110
          this, settings);
moel@137
   111
      }
moel@137
   112
moel@137
   113
      for (int i = 0; i < miniNGControls.Length; i++) {
moel@137
   114
        miniNGControls[i] = new Sensor("miniNG #" + (i / 2 + 1) +
moel@165
   115
          " Fan Channel " + (i % 2 + 1), 4 + i, SensorType.Control, this, 
moel@165
   116
          settings);
moel@118
   117
      }
moel@118
   118
moel@57
   119
      alternativeRequest = new MethodDelegate(DelayedAlternativeRequest);
moel@57
   120
moel@87
   121
      Open();
moel@87
   122
      Update(); 
moel@1
   123
    }
moel@1
   124
moel@1
   125
    private void ActivateSensor(Sensor sensor) {
moel@1
   126
      deactivating.Remove(sensor);
moel@1
   127
      if (!active.Contains(sensor)) {
moel@1
   128
        active.Add(sensor);
moel@15
   129
        if (SensorAdded != null)
moel@15
   130
          SensorAdded(sensor);
moel@1
   131
      }      
moel@1
   132
    }
moel@1
   133
moel@1
   134
    private void DeactivateSensor(Sensor sensor) {
moel@1
   135
      if (deactivating.Contains(sensor)) {
moel@1
   136
        active.Remove(sensor);
moel@1
   137
        deactivating.Remove(sensor);
moel@15
   138
        if (SensorRemoved != null)
moel@15
   139
          SensorRemoved(sensor);
moel@1
   140
      } else if (active.Contains(sensor)) {
moel@1
   141
        deactivating.Add(sensor);
moel@1
   142
      }     
moel@1
   143
    }
moel@1
   144
moel@57
   145
    private void ReadminiNG(int[] data, int number) {
moel@57
   146
      int offset = 1 + number * 65;
moel@57
   147
moel@57
   148
      if (data[offset + 61] != ENDFLAG)
moel@57
   149
        return;
moel@57
   150
moel@57
   151
      for (int i = 0; i < 2; i++) {
moel@57
   152
        Sensor sensor = miniNGTemperatures[number * 2 + i];
moel@57
   153
        if (data[offset + 7 + i] > 0) {
moel@63
   154
          sensor.Value = 0.5f * data[offset + 7 + i] + 
moel@63
   155
            sensor.Parameters[0].Value;
moel@57
   156
          ActivateSensor(sensor);
moel@57
   157
        } else {
moel@57
   158
          DeactivateSensor(sensor);
moel@57
   159
        }
moel@57
   160
      }
moel@57
   161
moel@57
   162
      for (int i = 0; i < 2; i++) {
moel@57
   163
        float maxRPM = 20.0f * data[offset + 44 + 2 * i];
moel@57
   164
moel@57
   165
        if (miniNGFans[number * 2 + i] == null)
moel@57
   166
          miniNGFans[number * 2 + i] = 
moel@88
   167
            new Sensor("miniNG #" + (number + 1) + " Fan Channel " + (i + 1),
moel@165
   168
            4 + number * 2 + i, SensorType.Fan, this, settings);
moel@57
   169
        
moel@57
   170
        Sensor sensor = miniNGFans[number * 2 + i];
moel@57
   171
moel@57
   172
        sensor.Value = 20.0f * data[offset + 43 + 2 * i];
moel@57
   173
        ActivateSensor(sensor);
moel@57
   174
      }
moel@137
   175
moel@137
   176
      for (int i = 0; i < 2; i++) {
moel@137
   177
        Sensor sensor = miniNGControls[number * 2 + i];
moel@137
   178
        sensor.Value = data[offset + 15 + i];
moel@137
   179
        ActivateSensor(sensor);
moel@137
   180
      }
moel@57
   181
    }
moel@57
   182
moel@1
   183
    private void ReadData() {
moel@1
   184
      int[] data = new int[285];
moel@1
   185
      for (int i = 0; i < data.Length; i++)
moel@87
   186
        data[i] = FTD2XX.ReadByte(handle);
moel@137
   187
      
moel@57
   188
      if (data[0] != STARTFLAG) {
moel@87
   189
        FTD2XX.FT_Purge(handle, FT_PURGE.FT_PURGE_RX);   
moel@1
   190
        return;
moel@1
   191
      }
moel@1
   192
moel@73
   193
      if (data[1] == 255 || data[1] == 88) { // bigNG
moel@57
   194
moel@57
   195
        if (data[274] != protocolVersion) 
moel@57
   196
          return;
moel@57
   197
moel@57
   198
        this.primaryData = data;
moel@57
   199
moel@57
   200
        for (int i = 0; i < digitalTemperatures.Length; i++)
moel@57
   201
          if (data[238 + i] > 0) {
moel@63
   202
            digitalTemperatures[i].Value = 0.5f * data[238 + i] + 
moel@63
   203
              digitalTemperatures[i].Parameters[0].Value;
moel@57
   204
            ActivateSensor(digitalTemperatures[i]);
moel@57
   205
          } else {
moel@57
   206
            DeactivateSensor(digitalTemperatures[i]);
moel@57
   207
          }
moel@57
   208
moel@57
   209
        for (int i = 0; i < analogTemperatures.Length; i++)
moel@57
   210
          if (data[260 + i] > 0) {
moel@63
   211
            analogTemperatures[i].Value = 0.5f * data[260 + i] +
moel@63
   212
              analogTemperatures[i].Parameters[0].Value;
moel@57
   213
            ActivateSensor(analogTemperatures[i]);
moel@57
   214
          } else {
moel@57
   215
            DeactivateSensor(analogTemperatures[i]);
moel@57
   216
          }
moel@57
   217
moel@57
   218
        for (int i = 0; i < sensorhubTemperatures.Length; i++)
moel@57
   219
          if (data[246 + i] > 0) {
moel@63
   220
            sensorhubTemperatures[i].Value = 0.5f * data[246 + i] +
moel@63
   221
              sensorhubTemperatures[i].Parameters[0].Value;
moel@57
   222
            ActivateSensor(sensorhubTemperatures[i]);
moel@57
   223
          } else {
moel@57
   224
            DeactivateSensor(sensorhubTemperatures[i]);
moel@57
   225
          }
moel@57
   226
moel@57
   227
        for (int i = 0; i < sensorhubFlows.Length; i++)
moel@57
   228
          if (data[231 + i] > 0 && data[234] > 0) {
moel@66
   229
            float pulsesPerSecond = (data[231 + i] * 4.0f) / data[234];
moel@63
   230
            float pulsesPerLiter = sensorhubFlows[i].Parameters[0].Value;
moel@57
   231
            sensorhubFlows[i].Value = pulsesPerSecond * 3600 / pulsesPerLiter;
moel@57
   232
            ActivateSensor(sensorhubFlows[i]);
moel@57
   233
          } else {
moel@57
   234
            DeactivateSensor(sensorhubFlows[i]);
moel@57
   235
          }
moel@86
   236
        
moel@57
   237
        for (int i = 0; i < fans.Length; i++) {
moel@57
   238
          float maxRPM = 11.5f * ((data[149 + 2 * i] << 8) | data[148 + 2 * i]);
moel@57
   239
moel@57
   240
          if (fans[i] == null)
moel@134
   241
            fans[i] = new Sensor("Fan Channel " + i, i, SensorType.Fan,
moel@63
   242
              this, new ParameterDescription[] {
moel@63
   243
                new ParameterDescription("MaxRPM", 
moel@63
   244
                  "Maximum revolutions per minute (RPM) of the fan.", maxRPM)
moel@165
   245
              }, settings);
moel@57
   246
moel@118
   247
          float value;
moel@118
   248
          if ((data[136] & (1 << i)) == 0)  // pwm mode
moel@118
   249
            value = 0.02f * data[137 + i];
moel@63
   250
          else // analog mode
moel@118
   251
            value = 0.01f * data[141 + i];
moel@118
   252
          
moel@118
   253
          fans[i].Value = fans[i].Parameters[0].Value * value;
moel@57
   254
          ActivateSensor(fans[i]);
moel@118
   255
moel@137
   256
          controls[i].Value = 100 * value;
moel@137
   257
          ActivateSensor(controls[i]);
moel@1
   258
        }
moel@1
   259
moel@57
   260
      } else if (data[1] == 253) { // miniNG #1
moel@57
   261
        this.alternativeData = data;
moel@1
   262
moel@57
   263
        ReadminiNG(data, 0);        
moel@57
   264
              
moel@137
   265
        if (data[66] == 253)  // miniNG #2
moel@57
   266
          ReadminiNG(data, 1);
moel@57
   267
      } 
moel@1
   268
    }
moel@1
   269
moel@165
   270
    public HardwareType HardwareType {
moel@165
   271
      get { return HardwareType.TBalancer; }
moel@1
   272
    }
moel@1
   273
moel@1
   274
    public string Name {
moel@1
   275
      get { return "T-Balancer bigNG"; }
moel@1
   276
    }
moel@1
   277
moel@109
   278
    public Identifier Identifier {
moel@109
   279
      get { return new Identifier("bigng", this.portIndex.ToString()); }
moel@1
   280
    }
moel@1
   281
moel@64
   282
    public IHardware[] SubHardware {
moel@64
   283
      get { return new IHardware[0]; }
moel@64
   284
    }
moel@64
   285
moel@1
   286
    public ISensor[] Sensors {
moel@1
   287
      get { return active.ToArray(); }
moel@1
   288
    }
moel@1
   289
moel@1
   290
    public string GetReport() {
moel@1
   291
      StringBuilder r = new StringBuilder();
moel@1
   292
moel@1
   293
      r.AppendLine("T-Balancer bigNG");
moel@1
   294
      r.AppendLine();
moel@87
   295
      r.Append("Port Index: "); r.AppendLine(portIndex.ToString());
moel@1
   296
      r.AppendLine();
moel@57
   297
moel@57
   298
      r.AppendLine("Primary System Information Answer");
moel@1
   299
      r.AppendLine();
moel@1
   300
      r.AppendLine("       00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F");
moel@1
   301
      r.AppendLine();
moel@1
   302
      for (int i = 0; i <= 0x11; i++) {
moel@1
   303
        r.Append(" "); r.Append((i << 4).ToString("X3")); r.Append("  ");
moel@1
   304
        for (int j = 0; j <= 0xF; j++) {
moel@1
   305
          int index = ((i << 4) | j);
moel@57
   306
          if (index < primaryData.Length) {
moel@1
   307
            r.Append(" ");
moel@57
   308
            r.Append(primaryData[index].ToString("X2"));
moel@1
   309
          }          
moel@1
   310
        }
moel@1
   311
        r.AppendLine();
moel@1
   312
      }
moel@1
   313
      r.AppendLine();
moel@1
   314
moel@57
   315
      if (alternativeData.Length > 0) {
moel@57
   316
        r.AppendLine("Alternative System Information Answer");
moel@57
   317
        r.AppendLine();
moel@57
   318
        r.AppendLine("       00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F");
moel@57
   319
        r.AppendLine();
moel@57
   320
        for (int i = 0; i <= 0x11; i++) {
moel@57
   321
          r.Append(" "); r.Append((i << 4).ToString("X3")); r.Append("  ");
moel@57
   322
          for (int j = 0; j <= 0xF; j++) {
moel@57
   323
            int index = ((i << 4) | j);
moel@57
   324
            if (index < alternativeData.Length) {
moel@57
   325
              r.Append(" ");
moel@57
   326
              r.Append(alternativeData[index].ToString("X2"));
moel@57
   327
            }
moel@57
   328
          }
moel@57
   329
          r.AppendLine();
moel@57
   330
        }
moel@57
   331
        r.AppendLine();
moel@57
   332
      }
moel@57
   333
moel@1
   334
      return r.ToString();
moel@1
   335
    }
moel@1
   336
moel@57
   337
    private void DelayedAlternativeRequest() {
moel@87
   338
      System.Threading.Thread.Sleep(500);      
moel@87
   339
      FTD2XX.Write(handle, new byte[] { 0x37 });
moel@57
   340
    }
moel@57
   341
moel@87
   342
    public void Open() {
moel@87
   343
      FTD2XX.FT_Open(portIndex, out handle); 
moel@87
   344
      FTD2XX.FT_SetBaudRate(handle, 19200);
moel@87
   345
      FTD2XX.FT_SetDataCharacteristics(handle, 8, 1, 0);
moel@87
   346
      FTD2XX.FT_SetFlowControl(handle, FT_FLOW_CONTROL.FT_FLOW_RTS_CTS, 0x11,
moel@87
   347
        0x13);
moel@87
   348
      FTD2XX.FT_SetTimeouts(handle, 1000, 1000);
moel@87
   349
      FTD2XX.FT_Purge(handle, FT_PURGE.FT_PURGE_ALL);
moel@87
   350
    }
moel@57
   351
moel@87
   352
    public void Update() {
moel@87
   353
      while (FTD2XX.BytesToRead(handle) >= 285)
moel@87
   354
        ReadData();
moel@87
   355
      if (FTD2XX.BytesToRead(handle) == 1)
moel@87
   356
        FTD2XX.ReadByte(handle);
moel@87
   357
moel@87
   358
      FTD2XX.Write(handle, new byte[] { 0x38 });
moel@87
   359
      alternativeRequest.BeginInvoke(null, null);
moel@1
   360
    }
moel@1
   361
moel@1
   362
    public void Close() {
moel@87
   363
      FTD2XX.FT_Close(handle);
moel@1
   364
    }
moel@1
   365
moel@1
   366
    public event SensorEventHandler SensorAdded;
moel@1
   367
    public event SensorEventHandler SensorRemoved;
moel@110
   368
moel@110
   369
    public void Accept(IVisitor visitor) {
moel@110
   370
      visitor.VisitHardware(this);
moel@110
   371
    }
moel@110
   372
moel@110
   373
    public void Traverse(IVisitor visitor) { }
moel@1
   374
  }
moel@1
   375
}