Wrap up backlight for Tough

- Rework Screen class for Core2 and Tough.
- Update nugets.

Author: josesimoes

M5StackCommon/Core2ToughCommon.cs

@@ -76,21 +76,33 @@ public static Pcf8563 ReatTimeClock
             get => _rtc;
         }
 
+#if M5CORE2
+
         /// <summary>
-        /// Sets on or off the Power Led.
+        /// Sets on or off the Power LED.
         /// </summary>
         public static bool PowerLed
         {
             get => _powerLed;
             set
             {
                 _powerLed = value;
-                _power.EnableLDO2(_powerLed);
+
+                if(_powerLed)
+                {
+                    // turn ON by setting duty cycle to 100%
+                    _power.Pwm1DutyCycleSetting1 = 10;
+                    _power.Pwm1DutyCycleSetting2 = 10;
+                }
+                else
+                {
+                    // tuen OFF by setting duty cycle to 0%
+                    _power.Pwm1DutyCycleSetting1 = 0;
+                    _power.Pwm1DutyCycleSetting2 = 0;
+                }
             }
         }
 
-#if M5CORE2
-
         /// <summary>
         /// Vibrate the M5Core2 when true.
         /// </summary>
@@ -136,21 +148,6 @@ public static Chs6540 TouchController
                 return _touchController;
             }
         }
-
-        /// <summary>
-        /// Gets or sets the state of the display backlight.
-        /// Set to <see langword="true"/> to turn on and <see langword="false"/> to turn off.
-        /// </summary>
-        public static bool Backlight
-        {
-            get => _backLight;
-            set
-            {
-                _backLight = value;
-                _power.EnableLDO3(_backLight);
-            }
-        }
-
 #endif
 
         /// <summary>
@@ -292,7 +289,8 @@ static Tough()
             I2cDevice i2c = new(new I2cConnectionSettings(1, Axp192.I2cDefaultAddress));
             _power = new(i2c);
 
-            // Configuration common for M5Core2 and Tough
+            // Configuration common for M5Core2 and M5Tough
+
             // VBUS-IPSOUT Pass-Through Management
             _power.SetVbusSettings(false, false, VholdVoltage.V4_0, true, VbusCurrentLimit.MilliAmper500);
             // Set Power off voltage 3.0v
@@ -303,87 +301,80 @@ static Tough()
             _power.SetChargingFunctions(true, ChargingVoltage.V4_2, ChargingCurrent.Current100mA, ChargingStopThreshold.Percent10);
             // Enable RTC BAT charge 
             _power.SetBackupBatteryChargingControl(true, BackupBatteryCharingVoltage.V3_0, BackupBatteryChargingCurrent.MicroAmperes200);
-            // 128ms power on, 4s power off
-            _power.SetButtonBehavior(LongPressTiming.S1, ShortPressTiming.Ms128, true, SignalDelayAfterPowerUp.Ms32, ShutdownTiming.S4);
+            
             // Set ADC all on
             _power.AdcPinEnabled = AdcPinEnabled.All;
             // Set ADC sample rate to 25Hz
             _power.AdcFrequency = AdcFrequency.Frequency25Hz;
             _power.AdcPinCurrent = AdcPinCurrent.MicroAmperes80;
             _power.BatteryTemperatureMonitoring = true;
             _power.AdcPinCurrentSetting = AdcPinCurrentSetting.AlwaysOn;
+            
             // GPIO0 is LDO
             _power.Gpio0Behavior = Gpio0Behavior.LowNoiseLDO;
             // GPIO0 LDO output 2.8V
             _power.PinOutputVoltage = PinOutputVoltage.V2_8;
-
-#if TOUGH
-            // PWM1 X
-            _power.Pwm1OutputFrequencySetting = 0;
-            // PWM1 Y1
-            _power.Pwm1DutyCycleSetting1 = 0xFF;
-            // PWM1 Y2
-            _power.Pwm1DutyCycleSetting2 = 0xFF;
-#endif
-
-            // enable pins
-#if M5CORE2
-            _power.LdoDcPinsEnabled = LdoDcPinsEnabled.DcDc1 | LdoDcPinsEnabled.DcDc3 | LdoDcPinsEnabled.Ldo2 | LdoDcPinsEnabled.Ldo3;
-#elif TOUGH
-            _power.LdoDcPinsEnabled = LdoDcPinsEnabled.DcDc1 | LdoDcPinsEnabled.Ldo2 | LdoDcPinsEnabled.Ldo3;
-#endif
-
             // Sets DCDC1 3350mV (ESP32 VDD)
             _power.DcDc1Voltage = ElectricPotential.FromVolts(3.35);
-            // Switch on the power
-            PowerLed = true;
 
-            // LCD + SD peripheral power supply
+            // LCD and peripherals power supply
             _power.LDO2OutputVoltage = ElectricPotential.FromVolts(3.3);
             _power.EnableLDO2(true);
 
+            // GPIO2 enables the speaker 
+            _power.Gpio2Behavior = Gpio12Behavior.MnosLeakOpenOutput;
+
+            // GPIO4 LCD reset (and also Touch controller reset on M5Core2)
+            _power.Gpio4Behavior = Gpio4Behavior.MnosLeakOpenOutput;
+
+            // Set temperature protection
+            _power.SetBatteryHighTemperatureThreshold(ElectricPotential.FromVolts(3.2256));
+
+            // This part of the code will handle the button behavior
+            _power.EnableButtonPressed(ButtonPressed.LongPressed | ButtonPressed.ShortPressed);
+            // 128ms power on, 4s power off
+            _power.SetButtonBehavior(LongPressTiming.S1, ShortPressTiming.Ms128, true, SignalDelayAfterPowerUp.Ms32, ShutdownTiming.S4);
+
 #if M5CORE2
+            // enable DCO and LDO outputs
+            _power.LdoDcPinsEnabled = LdoDcPinsEnabled.DcDc1 | LdoDcPinsEnabled.DcDc3 | LdoDcPinsEnabled.Ldo2 | LdoDcPinsEnabled.Ldo3;
+
             // Sets the Vibrator voltage
             _power.LDO3OutputVoltage = ElectricPotential.FromVolts(2.0);
             // vibrator off
             Vibrate = false;
 
-            // Sets the LCD Voltage to 2.8V
+            // Sets the LCD backlight voltage to 2.8V
             _power.DcDc3Voltage = ElectricPotential.FromVolts(2.8);
 
-            // GPIO1 PWM
+            // GPIO1 set to PWM to control power LED
             _power.Gpio1Behavior = Gpio12Behavior.PwmOutput;
 
+            // Switch on the power LED
+            PowerLed = true;
+
             // battery = 360mAh
             _power.ChargingCurrent = ChargingCurrent.Current360mA;
 
 #elif TOUGH
-            // Sets backlight voltage to 3.0
-            //_power.LDO3OutputVoltage = ElectricPotential.FromVolts(3.0);
-            Backlight = true;
-            _power.DcDc3Voltage = ElectricPotential.FromVolts(0);
+            // PWM1 X
+            _power.Pwm1OutputFrequencySetting = 0;
+            // PWM1 Y1
+            _power.Pwm1DutyCycleSetting1 = 0xFF;
+            // PWM1 Y2
+            _power.Pwm1DutyCycleSetting2 = 0xFF;
 
-              // GPIO1 Touch Reset
+            // enable DCO and LDO outputs
+            _power.LdoDcPinsEnabled = LdoDcPinsEnabled.DcDc1 | LdoDcPinsEnabled.Ldo2 | LdoDcPinsEnabled.Ldo3;
+            
+            // Sets the LCD backlight voltage to 3V
+            _power.LDO3OutputVoltage = ElectricPotential.FromVolts(3.0);
+
+              // GPIO1 is reset for Touch controller
             _power.Gpio1Behavior = Gpio12Behavior.MnosLeakOpenOutput;
 
 #endif
 
-            // GPIO2 speaker enable
-            _power.Gpio2Behavior = Gpio12Behavior.MnosLeakOpenOutput;
-
-            // GPIO4 LCD reset (and Touch reset on M5Core2)
-            _power.Gpio4Behavior = Gpio4Behavior.MnosLeakOpenOutput;
-
-            // Set GPIO4 as output (rest LCD)
-            // _power.Gpio4Behavior = Gpio4Behavior.MnosLeakOpenOutput;
-
-            // Set temperature protection
-            _power.SetBatteryHighTemperatureThreshold(ElectricPotential.FromVolts(3.2256));
-
-            // This part of the code will handle the button behavior
-            //_power.EnableButtonPressed(ButtonPressed.LongPressed | ButtonPressed.ShortPressed);
-           // _power.SetButtonBehavior(LongPressTiming.S2, ShortPressTiming.Ms128, true, SignalDelayAfterPowerUp.Ms32, ShutdownTiming.S10);
-
             // Setup buttons
             _gpio = new();
 

M5StackCommon/Screen.cs

@@ -12,7 +12,11 @@
 namespace nanoFramework.M5Stack
 {
     /// <summary>
-    /// M5Core2 screen class
+#if M5CORE2
+    /// M5Core2 screen class.
+#elif TOUGH
+    /// M5Tough screen class.
+#endif
     /// </summary>
     public class Screen : ScreenBase
     {
@@ -21,11 +25,12 @@ public class Screen : ScreenBase
         /// </summary>
         public const int DefaultMemoryAllocationBitmap = 320 * 240 * 4;
 
+        private const byte DefaultScreenBrightness = 75;
         private const int ChipSelect = 5;
         private const int DataCommand = 15;
         private const int Reset = -1;
         private static Axp192 _power;
-        private static byte _lumi;
+        private static byte _brightness;
         private static bool _isInitialized = false;
 
         /// <summary>
@@ -39,8 +44,9 @@ public Screen(int memoryBitMapAllocation = DefaultMemoryAllocationBitmap)
                 return;
             }
 
-            // We're allocating anough memory for the full screen as this is a SPRAM board
+            // We're allocating enough memory for the full screen because these targets have PSRAM
             MemoryAllocationBitmap = memoryBitMapAllocation;
+            // backligth is not controlled by the screen driver
             BackLightPin = -1;
 
 #if M5CORE2
@@ -49,10 +55,7 @@ public Screen(int memoryBitMapAllocation = DefaultMemoryAllocationBitmap)
             _power = M5Stack.Tough.Power;
 #endif
 
-            // Enable the screen
-            Enabled = true;
-
-            // Reset
+            // Reset screen
             _power.Gpio4Value = PinValue.Low;
             Thread.Sleep(100);
             _power.Gpio4Value = PinValue.High;
@@ -61,56 +64,57 @@ public Screen(int memoryBitMapAllocation = DefaultMemoryAllocationBitmap)
             // Create the screen
             DisplayControl.Initialize(new SpiConfiguration(2, ChipSelect, DataCommand, Reset, BackLightPin), new ScreenConfiguration(0, 0, 320, 240), (uint)MemoryAllocationBitmap);
 
-            // For M5Core2, values from 2.5 to 3V are working fine
-            // 3.0V for the screen            
-            LuminosityPercentage = 100;
+            // set initial value for brightness
+            BrightnessPercentage = DefaultScreenBrightness;
 
-#if M5CORE2
-            _power.EnableDCDC3(true);
-#elif TOUGH
-            _power.EnableLDO3(true);
-#endif
+            // enable back-light
+            Enabled = true;
 
             _isInitialized = true;
         }
 
         /// <summary>
         /// Enables or disables the screen.
         /// </summary>
+        /// <value><see langword="true"/> to enable the screen, <see langword="false"/> to disable it.</value>
         public static new bool Enabled
         {
             get => IsEnabled;
 
             set
             {
                 IsEnabled = value;
-                _power.EnableLDO2(IsEnabled);
+
+#if M5CORE2
+                _power.EnableDCDC3(IsEnabled);
+#elif TOUGH
+            _power.EnableLDO3(IsEnabled);
+#endif
             }
         }
 
         /// <summary>
-        /// Sets or gets the screen luminosity.
+        /// Gets or sets the screen brightness.
         /// </summary>
-        /// <remarks> On M5Core2, anything less than 20% will be fully black</remarks>
-        public static new byte LuminosityPercentage
+        /// <value>Brightness as percentage.</value>
+        public static new byte BrightnessPercentage
         {
-            get => _lumi;
+            get => _brightness;
 
             set
             {
-
-                // For M5Core2, values from 2.5 to 3V are working fine
+                // For M5Core2 and M5Tough, values from 2.5 to 3V are working fine
                 // 2.5 V = dark, 3.0 V full luminosity
-                _lumi = (byte)(value > 100 ? 100 : _lumi);
-
-#if TOUGH
-                _power.LDO2OutputVoltage = ElectricPotential.FromVolts(_lumi * 0.5 / 100.0 + 2.0);
-#elif M5CORE2
-                _power.LDO3OutputVoltage = ElectricPotential.FromVolts((byte)(_lumi * 0.5 / 100.0 + 2.5));
+                _brightness = (byte)(value > 100 ? 100 : value);
+                var backLightVoltage = ElectricPotential.FromVolts(_brightness * 0.5 / 100.0 + 2.5);
+#if M5CORE2
+                _power.LDO3OutputVoltage = backLightVoltage;
+#elif TOUGH
+            _power.LDO3OutputVoltage = backLightVoltage;
 #endif
-
             }
         }
     }
 }
-#endif
+
+#endif

Tests/M5Core2TestApp/M5Core2TestApp.nfproj

@@ -172,4 +172,4 @@
       <ProjectConfigurationsDeclaredAsItems />
     </ProjectCapabilities>
   </ProjectExtensions>
-</Project>
+</Project>

Tests/M5Core2TestApp/packages.config

@@ -34,4 +34,4 @@
   <package id="UnitsNet.nanoFramework.ElectricPotential" version="4.132.0" targetFramework="netnanoframework10" />
   <package id="UnitsNet.nanoFramework.Power" version="4.132.0" targetFramework="netnanoframework10" />
   <package id="UnitsNet.nanoFramework.Temperature" version="4.132.0" targetFramework="netnanoframework10" />
-</packages>
+</packages>

Tests/M5StickTestApp/M5StickTestApp.nfproj

@@ -132,4 +132,4 @@
       <ProjectConfigurationsDeclaredAsItems />
     </ProjectCapabilities>
   </ProjectExtensions>
-</Project>
+</Project>

Tests/M5StickTestApp/packages.config

@@ -24,4 +24,4 @@
   <package id="UnitsNet.nanoFramework.ElectricPotential" version="4.132.0" targetFramework="netnanoframework10" />
   <package id="UnitsNet.nanoFramework.Power" version="4.132.0" targetFramework="netnanoframework10" />
   <package id="UnitsNet.nanoFramework.Temperature" version="4.132.0" targetFramework="netnanoframework10" />
-</packages>
+</packages>

Tests/ToughTestApp/Program.cs

@@ -14,20 +14,23 @@
 
 Debug.WriteLine("Hello from Tough!");
 
-const string Ssid = "SSID";
-const string Password = "YourWifiPasswordHere";
-// Give 60 seconds to the wifi join to happen
-CancellationTokenSource cs = new(60000);
-var success = WifiNetworkHelper.ConnectDhcp(Ssid, Password, requiresDateTime: true, token: cs.Token);
-if (!success)
-{
-    // Something went wrong, you can get details with the ConnectionError property:
-    Debug.WriteLine($"Can't connect to the network, error: {WifiNetworkHelper.Status}");
-    if (WifiNetworkHelper.HelperException != null)
-    {
-        Debug.WriteLine($"ex: {WifiNetworkHelper.HelperException}");
-    }
-}
+Console.WriteLine("Hello from Tough!");
+
+
+//const string Ssid = "SSID";
+//const string Password = "YourWifiPasswordHere";
+//// Give 60 seconds to the wifi join to happen
+//CancellationTokenSource cs = new(60000);
+//var success = WifiNetworkHelper.ConnectDhcp(Ssid, Password, requiresDateTime: true, token: cs.Token);
+//if (!success)
+//{
+//    // Something went wrong, you can get details with the ConnectionError property:
+//    Debug.WriteLine($"Can't connect to the network, error: {WifiNetworkHelper.Status}");
+//    if (WifiNetworkHelper.HelperException != null)
+//    {
+//        Debug.WriteLine($"ex: {WifiNetworkHelper.HelperException}");
+//    }
+//}
 
 Tough.TouchEvent += TouchEventCallback;