EasyNixie
Public Member Functions | Public Attributes | List of all members
EasyNixie Class Reference

The main EasyNixie class. More...

#include <EasyNixie.h>

Public Member Functions

 EasyNixie (uint8_t outputEnable, uint8_t shcp, uint8_t stcp, uint8_t dsin)
 This constructor takes 4 pin names as arguments, they are labeled OUT_EN, SHCP, STCP and DSIN on your EasyNixie module. More...
 
void SetNixie (uint8_t number, uint8_t color, bool voltage=true, bool comma=false, uint16_t dimming=0)
 Set nixie digit/symbol on your EasyNixie. If you have multiple modules connected 'in series' (EasyNixie1 DSOUT->EasyNixie2 DSIN) the value is set to the first module in series(The one which has DSIN connected to the Arduino). To display the value set with this method use the Latch method! More...
 
void Latch (void)
 This method 'displays' the digit that you have set using SetNixie, be sure to call it after SetNixie.
 

Public Attributes

uint8_t outputEnable
 The microcontroller pin connected to OUT_EN pin of the EasyNixie.
 
uint8_t shcp
 The microcontroller pin connected to SHCP pin of the EasyNixie.
 
uint8_t stcp
 The microcontroller pin connected to STCP pin of the EasyNixie.
 
uint8_t dsin
 The microcontroller pin connected to DSIN pin of the EasyNixie.
 

Detailed Description

The main EasyNixie class.

Constructor & Destructor Documentation

◆ EasyNixie()

EasyNixie::EasyNixie ( uint8_t  outputEnable,
uint8_t  shcp,
uint8_t  stcp,
uint8_t  dsin 
)

This constructor takes 4 pin names as arguments, they are labeled OUT_EN, SHCP, STCP and DSIN on your EasyNixie module.

Parameters
outputEnableThe microcontroller pin connected to OUT_EN pin of the EasyNixie
shcpThe microcontroller pin connected to SHCP pin of the EasyNixie.
stcpThe microcontroller pin connected to STCP pin of the EasyNixie.
dsinThe microcontroller pin connected to DSIN pin of the EasyNixie.

Member Function Documentation

◆ SetNixie()

void EasyNixie::SetNixie ( uint8_t  number,
uint8_t  color,
bool  voltage = true,
bool  comma = false,
uint16_t  dimming = 0 
)

Set nixie digit/symbol on your EasyNixie. If you have multiple modules connected 'in series' (EasyNixie1 DSOUT->EasyNixie2 DSIN) the value is set to the first module in series(The one which has DSIN connected to the Arduino). To display the value set with this method use the Latch method!

Parameters
numberThe digit/symbol you want to display. The digits can be swapped if you are using non-standard nixies(not In-12/In-17).
colorLed color, checkout the Avalilable led colors, I should have probably used enum to avoid illegal arguments, but I am too lazy to rewrite and retest all the examples...
voltageThis argument enables the high-voltage convertor, be sure to disconnect the EasyNixie from PC, when you are calling the function with this argument set to true. You can flash the code with VPOWER pin disconneted, then disconnect the board from PC, connect to some external power source, then connect the VPOWER pin.
commaOr the 'decimal point'. This argument controls the decimal point of In-12B.
dimmingBasically, just PWM on the outputEnable pin. 0 means max brightness, 255 means min brightness.

The documentation for this class was generated from the following files: