Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
learn:libraries:linx:reference:firmware:start [2015/08/10 14:35]
samkristoff
learn:libraries:linx:reference:firmware:start [2015/08/12 17:14] (current)
samkristoff
Line 1: Line 1:
 ====== LINX Firmware Reference ====== ====== LINX Firmware Reference ======
  
 +The LINX firmware provides a hardware abstraction layer for common peripherals and device functions making it easy for the end user to write easily portable code.  ​
  
- +<columns 100% first column top  50%> 
-===== Variables ===== +=== Functions ​=== 
-===Device Identification=== +**Analog**
-  ​[[learn:​libraries:​linx:​reference:​firmware:​devicefamily | DeviceFamily]] +
-  ​[[learn:​libraries:​linx:​reference:​firmware:​deviceid | DeviceID]] +
-  ​[[learn:​libraries:​linx:​reference:​firmware:​devicenamelen | DeviceNameLen]] +
-  ​[[learn:​libraries:​linx:​reference:​firmware:​devicename | DeviceName]] +
-... +
- +
-===Constants=== +
-  * INPUT | OUTPUT +
-  * HIGH | LOW +
-  * [[constants| DEFAULT]] | INTERNAL | EXTERNAL +
-... +
- +
-===== Functions ===== +
-===Analog===+
   * [[learn:​libraries:​linx:​reference:​firmware:​analogread | AnalogRead()]]   * [[learn:​libraries:​linx:​reference:​firmware:​analogread | AnalogRead()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​analogsetref | AnalogSetRef()]]   * [[learn:​libraries:​linx:​reference:​firmware:​analogsetref | AnalogSetRef()]]
-===Digital===+**Digital**
   * [[learn:​libraries:​linx:​reference:​firmware:​digitalread |DigitalRead()]]   * [[learn:​libraries:​linx:​reference:​firmware:​digitalread |DigitalRead()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​digitalreadpulsewidth |DigitalReadPulseWidth()]]   * [[learn:​libraries:​linx:​reference:​firmware:​digitalreadpulsewidth |DigitalReadPulseWidth()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​digitalwrite |DigitalWrite()]]   * [[learn:​libraries:​linx:​reference:​firmware:​digitalwrite |DigitalWrite()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​digitalwritesquarewave |DigitalWriteSquareWave()]]   * [[learn:​libraries:​linx:​reference:​firmware:​digitalwritesquarewave |DigitalWriteSquareWave()]]
-===PWM===+**PWM**
   * [[learn:​libraries:​linx:​reference:​firmware:​pwmsetdutycycle | PwmSetDutyCycle()]]   * [[learn:​libraries:​linx:​reference:​firmware:​pwmsetdutycycle | PwmSetDutyCycle()]]
-===SPI===+**SPI**
   * [[learn:​libraries:​linx:​reference:​firmware:​spiopenmaster | SpiOpenMaster()]]   * [[learn:​libraries:​linx:​reference:​firmware:​spiopenmaster | SpiOpenMaster()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​spisetbitorder | SpiSetBitOrder()]]   * [[learn:​libraries:​linx:​reference:​firmware:​spisetbitorder | SpiSetBitOrder()]]
Line 34: Line 21:
   * [[learn:​libraries:​linx:​reference:​firmware:​spisetspeed | SpiSetSpeed()]]   * [[learn:​libraries:​linx:​reference:​firmware:​spisetspeed | SpiSetSpeed()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​spiwriteread | SpiWriteRead()]]   * [[learn:​libraries:​linx:​reference:​firmware:​spiwriteread | SpiWriteRead()]]
-===I2C===+**I2C**
   * [[learn:​libraries:​linx:​reference:​firmware:​i2copenmaster | I2cOpenMaster()]]   * [[learn:​libraries:​linx:​reference:​firmware:​i2copenmaster | I2cOpenMaster()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​i2csetspeed | I2cSetSpeed()]]   * [[learn:​libraries:​linx:​reference:​firmware:​i2csetspeed | I2cSetSpeed()]]
Line 40: Line 27:
   * [[learn:​libraries:​linx:​reference:​firmware:​i2cread | I2cRead()]]   * [[learn:​libraries:​linx:​reference:​firmware:​i2cread | I2cRead()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​i2cclose | I2cClose()]]   * [[learn:​libraries:​linx:​reference:​firmware:​i2cclose | I2cClose()]]
-===UART===+**UART**
   * [[learn:​libraries:​linx:​reference:​firmware:​uartopen | UartOpen()]]   * [[learn:​libraries:​linx:​reference:​firmware:​uartopen | UartOpen()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​uartsetbaudrate | UartSetBaudRate()]]   * [[learn:​libraries:​linx:​reference:​firmware:​uartsetbaudrate | UartSetBaudRate()]]
Line 46: Line 33:
   * [[learn:​libraries:​linx:​reference:​firmware:​uartread | UartRead()]]   * [[learn:​libraries:​linx:​reference:​firmware:​uartread | UartRead()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​uartwrite | UartWrite()]]   * [[learn:​libraries:​linx:​reference:​firmware:​uartwrite | UartWrite()]]
-  * [[learn:​libraries:​linx:​reference:​firmware:​uartwriteln | UartWriteln()]] 
   * [[learn:​libraries:​linx:​reference:​firmware:​uartclose | UartClose()]]   * [[learn:​libraries:​linx:​reference:​firmware:​uartclose | UartClose()]]
-===Servo===+**Servo**
   * [[learn:​libraries:​linx:​reference:​firmware:​servoopen | ServoOpen()]]   * [[learn:​libraries:​linx:​reference:​firmware:​servoopen | ServoOpen()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​servosetpulsewidth | ServoSetPulseWidth()]]   * [[learn:​libraries:​linx:​reference:​firmware:​servosetpulsewidth | ServoSetPulseWidth()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​servoclose | ServoClose()]]   * [[learn:​libraries:​linx:​reference:​firmware:​servoclose | ServoClose()]]
-===WS2812===+**WS2812**
   * [[learn:​libraries:​linx:​reference:​firmware:​ws2812open | Ws2812Open()]]   * [[learn:​libraries:​linx:​reference:​firmware:​ws2812open | Ws2812Open()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​ws2812writeonepixel | Ws2812WriteOnePixel()]]   * [[learn:​libraries:​linx:​reference:​firmware:​ws2812writeonepixel | Ws2812WriteOnePixel()]]
Line 58: Line 44:
   * [[learn:​libraries:​linx:​reference:​firmware:​ws2812refresh | Ws2812Refresh()]]   * [[learn:​libraries:​linx:​reference:​firmware:​ws2812refresh | Ws2812Refresh()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​ws2812close | Ws2812Close()]]   * [[learn:​libraries:​linx:​reference:​firmware:​ws2812close | Ws2812Close()]]
-===General===+**General**
   * [[learn:​libraries:​linx:​reference:​firmware:​reversebits | ReverseBits()]]   * [[learn:​libraries:​linx:​reference:​firmware:​reversebits | ReverseBits()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​getmilliseconds | GetMilliSeconds()]]   * [[learn:​libraries:​linx:​reference:​firmware:​getmilliseconds | GetMilliSeconds()]]
Line 65: Line 51:
   * [[learn:​libraries:​linx:​reference:​firmware:​nonvolatilewrite | NonVolatileWrite()]]   * [[learn:​libraries:​linx:​reference:​firmware:​nonvolatilewrite | NonVolatileWrite()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​nonvolatileread | NonVolatileRead()]]   * [[learn:​libraries:​linx:​reference:​firmware:​nonvolatileread | NonVolatileRead()]]
-===Debug===+**Debug**
   * [[learn:​libraries:​linx:​reference:​firmware:​enabledebug | EnableDebug()]]   * [[learn:​libraries:​linx:​reference:​firmware:​enabledebug | EnableDebug()]]
   * [[learn:​libraries:​linx:​reference:​firmware:​debugprint | DebugPrint()]]   * [[learn:​libraries:​linx:​reference:​firmware:​debugprint | DebugPrint()]]
-  * [[learn:​libraries:​linx:​reference:​firmware:​debugprintln | DebugPrintln()]] 
   * [[learn:​libraries:​linx:​reference:​firmware:​debugprintpacket | DebugPrintPacket()]]   * [[learn:​libraries:​linx:​reference:​firmware:​debugprintpacket | DebugPrintPacket()]]
 +
 +<​newcolumn second column top 50%>
 +=== Variables ===
 +**Device Identification**
 +  * [[learn:​libraries:​linx:​reference:​firmware:​devicefamily | DeviceFamily]]
 +  * [[learn:​libraries:​linx:​reference:​firmware:​deviceid | DeviceID]]
 +  * [[learn:​libraries:​linx:​reference:​firmware:​devicenamelen | DeviceNameLen]]
 +  * [[learn:​libraries:​linx:​reference:​firmware:​devicename | DeviceName]]
 +
 +**Constants**
 +  * [[gpio-constants|INPUT]] | [[gpio-constants|OUTPUT]] \\ \\ 
 +  * [[gpio-constants|LOW]] | [[gpio-constants|HIGH]] \\ \\ 
 +  * [[analog-constants| DEFAULT]] | [[analog-constants | INTERNAL]] | [[analog-constants | EXTERNAL]] \\ \\ 
 +  * [[numeric-constants | BIN]] | [[numeric-constants | OCT]] | [[numeric-constants | DEC]] | [[numeric-constants | HEX]] \\ \\ 
 +  * [[bitorder-constants | LSBFIRST]] | [[bitorder-constants | MSBFIRST]] \\ \\ 
 +  * [[i2c-constants | EOF_STOP]] | [[i2c-constants | EOF_RESTART]] | [[i2c-constants | EOF_RESTART_NOSTOP]] | [[i2c-constants | EOF_NOSTOP]] \\ \\ 
 +  *** Non-Volatile Storage**
 +     * [[nvs-constants | NVS_USERID]]
 +     * [[nvs-constants | NVS_ETHERNET_IP]]
 +     * [[nvs-constants | NVS_ETHERNET_PORT]]
 +     * [[nvs-constants | NVS_WIFI_IP]]
 +     * [[nvs-constants | NVS_WIFI_PORT]]
 +     * [[nvs-constants | NVS_WIFI_SSID_SIZE]]
 +     * [[nvs-constants | NVS_WIFI_SSID]]
 +     * [[nvs-constants | NVS_WIFI_SECURITY_TYPE]]
 +     * [[nvs-constants | NVS_WIFI_PW_SIZE]]
 +     * [[nvs-constants | NVS_WIFI_PW]]
 +     * [[nvs-constants | NVS_SERIAL_INTERFACE_MAX_BAUD]]
 +\\ 
 +</​columns>​
 +\\ 
 +===Related Links===
 +----
 +[[learn:​libraries:​linx:​reference:​labview:​start]]
 +
 +~~NOTOC~~