-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c5b6224
commit 6e4253a
Showing
1 changed file
with
48 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,49 @@ | ||
| # eink-xplained-pro-asf3 | ||
|
|
||
| ## Introduction | ||
|
|
||
| Eink Xplained Pro ASF3 Software Library with example projects for use with Microchip SAM MCUs. | ||
|
|
||
| This software library is designed to work with the following displays and driver ICs: | ||
|
|
||
| - ED029TC1 : UC8151 | ||
| - *HINK-E0154A05 : SSD1608 (not yet implemented)* | ||
| - ED057TC2 : UC8159 | ||
|
|
||
| It also includes several open source fonts in varying sizes and weights. | ||
|
|
||
| Note that the software library and each example project has a **doxygen** folder with documentation inside (open *doxygen.html* to get started). | ||
|
|
||
| #### Note | ||
| > The library only allows a single display to be connected to the MCU. | ||
| ## Usage | ||
|
|
||
| The folder structure should be maintained after download as the example projects use relative paths to reference the software library. Note as well that the repository should be downloaded to your root C: folder as the folder structure can cause Windows to produce errors such as: | ||
| > The source file name(s) are larger than is supported by the file system | ||
| ## Product Support | ||
|
|
||
| Note that Microchip has ended development for the ASF3 software library, but is currently continuing to support it. With this in mind, the Eink Software Library only supports a range of Microchip devices but an ASF4 Eink Library is currently under development to bridge this gap. At present the ASF3 Eink Software Library supports any MCUs that make use of the ASF3 IOPORT Service. There are a number of example projects to show the different chips that are supported: | ||
| - [SAM4E](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_sam4e_ed029tc1_1_2) | ||
| - [SAM4S](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_sam4s_ed057tc2_1_2) | ||
| - [SAMD20](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samd20_ed029tc1_1_2) | ||
| - [SAMD21](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samd21_ed029tc1_1_2) | ||
| - [SAMG55](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samg55_ed057tc2_1_2) | ||
| - [SAML21A](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_saml21a_ed029tc1_1_2) | ||
| - [SAML21B](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_saml21b_ed029tc1_1_2) | ||
| - [SAMV71](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samv71_ed057tc2_1_2) | ||
| - [SAMW25](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samw25_ed029tc1_1_2) | ||
|
|
||
| ## Compilation Information | ||
|
|
||
| # eink-xplained-pro-asf3 | ||
|
|
||
| ## Introduction | ||
|
|
||
| Eink Xplained Pro ASF3 Software Library with example projects for use with Microchip SAM MCUs. | ||
|
|
||
| This software library is designed to work with the following displays and driver ICs: | ||
|
|
||
| - ED029TC1 : UC8151 | ||
| - *HINK-E0154A05 : SSD1608 (not yet implemented)* | ||
| - ED057TC2 : UC8159 | ||
|
|
||
| It also includes several open source fonts in varying sizes and weights. | ||
|
|
||
| Note that the software library and each example project has a **doxygen** folder with documentation inside (open *doxygen.html* to get started). | ||
|
|
||
| #### Note | ||
| > The library only allows a single display to be connected to the MCU. | ||
| ## Usage | ||
|
|
||
| The folder structure should be maintained after download as the example projects use relative paths to reference the software library. Note as well that the repository should be downloaded to your root C: folder as the folder structure can cause Windows to produce errors such as: | ||
| > The source file name(s) are larger than is supported by the file system | ||
| ## Product Support | ||
|
|
||
| Note that Microchip has ended development for the ASF3 software library. With this in mind, the Eink Software Library only supports a range of Microchip devices and is also no longer supported. For newer devices and for the full range of displays, please see [ASF4 Eink Library](https://github.com/Ineltek-UK/eink-xplained-pro-asf4) which is still being maintained. | ||
|
|
||
| At present the ASF3 Eink Software Library supports any MCUs that make use of the ASF3 IOPORT Service. There are a number of example projects to show the different chips that are supported: | ||
| - [SAM4E](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_sam4e_ed029tc1_1_2) | ||
| - [SAM4S](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_sam4s_ed057tc2_1_2) | ||
| - [SAMD20](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samd20_ed029tc1_1_2) | ||
| - [SAMD21](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samd21_ed029tc1_1_2) | ||
| - [SAMG55](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samg55_ed057tc2_1_2) | ||
| - [SAML21A](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_saml21a_ed029tc1_1_2) | ||
| - [SAML21B](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_saml21b_ed029tc1_1_2) | ||
| - [SAMV71](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samv71_ed057tc2_1_2) | ||
| - [SAMW25](https://github.com/Ineltek-UK/eink-xplained-pro-asf3/tree/master/example_projects/eink_asf3_1_2/eink_xplained_samw25_ed029tc1_1_2) | ||
|
|
||
| The following displays are also supported: | ||
| - Eink Xplained Pro | ||
| - ED029TC1 (2.9" B/W Display) | ||
| - EL029TR1 (2.9" B/W/R Display) | ||
| - Eink XL Xplained Pro | ||
| - ED057TC2 (5.7" B/W Display) | ||
|
|
||
| ## Compilation Information | ||
|
|
||
| This software was written for the GNU GCC compiler using Atmel Studio 7.0 and requires ASF version 3 (originally compiled using ASF version 3.42.0). Other compilers may or may not work. |