Hilscher netX microcontroller driver  V0.0.5.0
Documentation of the netX driver package
netx_drv_mled.h File Reference

Header file of MLED DRV module. More...

#include "netx_drv.h"
Include dependency graph for netx_drv_mled.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  DRV_MLED_CONFIGURATION_T
 The configuration of the driver. More...
 
struct  DRV_MLED_HANDLE_T
 The handle of the driver. More...
 

Typedefs

typedef uint32_t DRV_MLED_MSK_T
 Type definition analog to the dio definition for the mleds as mask. More...
 
typedef uint32_t DRV_MLED_ID_T
 Type definition analog to the dio definition for the mleds by id. More...
 

Enumerations

enum  DRV_MLED_PRESCALE_BORDER_E {
  DRV_MLED_PRESCALE_BORDER_RESET = 0x00ul,
  DRV_MLED_PRESCALE_BORDER_1 = 0x01ul,
  DRV_MLED_PRESCALE_BORDER_DEFAULT = 0x400ul,
  DRV_MLED_PRESCALE_BORDER_1024 = 0x400ul,
  DRV_MLED_PRESCALE_BORDER_MIN = DRV_MLED_PRESCALE_BORDER_1,
  DRV_MLED_PRESCALE_BORDER_MAX = DRV_MLED_PRESCALE_BORDER_1024
}
 The MLED prescale counter border as f_pwm = f_clk / (512 * (prescale_counter_max + 1)) More...
 
enum  DRV_MLED_BLINK_BORDER_E {
  DRV_MLED_BLINK_BORDER_RESET = 0x00ul,
  DRV_MLED_BLINK_BORDER_1 = 0x01ul,
  DRV_MLED_BLINK_BORDER_DEFAULT = 0x32ul,
  DRV_MLED_BLINK_BORDER_512 = 0x200ul,
  DRV_MLED_BLINK_BORDER_MIN = DRV_MLED_BLINK_BORDER_1,
  DRV_MLED_BLINK_BORDER_MAX = DRV_MLED_BLINK_BORDER_512
}
 The MLED blink counter border as f_blink = 50 Hz / (blink_counter_border) More...
 
enum  DRV_MLED_BRIGHTNESS_E {
  DRV_MLED_BRIGHTNESS_RESET = 0x00ul,
  DRV_MLED_BRIGHTNESS_1 = 0x01ul,
  DRV_MLED_BRIGHTNESS_OFF = DRV_MLED_BRIGHTNESS_1,
  DRV_MLED_BRIGHTNESS_256 = 0x100ul,
  DRV_MLED_BRIGHTNESS_FULL = DRV_MLED_BRIGHTNESS_256,
  DRV_MLED_BRIGHTNESS_DEFAULT = DRV_MLED_BRIGHTNESS_256,
  DRV_MLED_BRIGHTNESS_MIN = DRV_MLED_BRIGHTNESS_1,
  DRV_MLED_BRIGHTNESS_MAX = DRV_MLED_BRIGHTNESS_256
}
 The MLED brightness duty=([value]-1)/255. More...
 
enum  DRV_MLED_MODE_E {
  DRV_MLED_MODE_STANDARD = 0x00ul,
  DRV_MLED_MODE_LINE_REGISTER = 0x01ul,
  DRV_MLED_MODE_BLINK = 0x02ul,
  DRV_MLED_MODE_BYPASS = 0x03ul,
  DRV_MLED_MODE_MAX = DRV_MLED_MODE_BYPASS
}
 The MLED modes. More...
 

Detailed Description

Header file of MLED DRV module.

Revision
4538
Date
2018-11-22 17:26:55 +0100 (Do, 22 Nov 2018)
Note
Exclusion of Liability for this demo software: The following software is intended for and must only be used for reference and in an evaluation laboratory environment. It is provided without charge and is subject to alterations. There is no warranty for the software, to the extent permitted by applicable law. Except when otherwise stated in writing the copyright holders and/or other parties provide the software "as is" without warranty of any kind, either expressed or implied. Please refer to the Agreement in README_DISCLAIMER.txt, provided together with this file! By installing or otherwise using the software, you accept the terms of this Agreement. If you do not agree to the terms of this Agreement, then do not install or use the Software!

Definition in file netx_drv_mled.h.