jdunmire / kicad-esp8266 Goto Github PK

Schematic symbols and PCB footprints for ESP8266 modules

License: Other

OpenSCAD 100.00%

kicad-esp8266's Introduction

kicad-ESP8266 - a library for KiCAD

This project has both schematic symbols, footprints, and 3d models for ESP8266 based modules. It is a work-in-progress. Additions and corrections are welcome. Enter a pull request or file an issue on GitHub.

The present modules are:

ESP-01 - Note that there are two versions of this module available on open market. The schematic symbol is for the v090 version which is probably the same as the v080. There is an older version that does not include any GPIO signals. The footprint is the same for all of the ESP-01 modules.
ESP-12 - This is includes an alias part, ESP-07v2, that is suitable for the 16 pin variant of the ESP-07. Note that there is a 14 pin version of the ESP-07 that has different signals and pinout. The footprint for the ESP-12 (and ESP-07v2) elongated through-hole pads to match those modules.
ESP-201 - This is a 26 pin module with pins on 0.1 inch spacing. I could not find any official measurements for the pin locations so the footprint was created from empirical measurements on the unit I have.
ESP-12E - This is for the 22 pin variant of the ESP-12. ~~Though all the esp-12 signals are in the same place on ESP-12E, pin numbers have changed.~~ As of 2016/12/06 the pin numbers on the ESP-12E have been changed to be compatible with the ESP-12. If you need the old pin numbers they are still available on the oldNumbers branch.
ESP-07v2 - ESP-07 that is pin compatible with the ESP-12.
ESP-13-WROOM-02
There is a footprint for the ESP-06, but no supporting schematic symbol.

There are 3d models for the ESP-07v2, ESP-13, ESP-12 and ESP-12E.

WARNINGS

The symbols, footprints, and 3d models have not been tested. They are based on published images and measurements on individual samples.
The .dcm file contains HTML links to information on sites I used when creating this library, however I do not have any control over the sites themselves. Follow the links with caution.
This library distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Use

Clone this archive to a convenient location on your computer. These are the commands I use on Linux to create a copy in ~/kicad/libraries/kicad-ESP8266:
```
mkdir -p ~/kicad/libraries/
cd ~/kicad/libraries/
git clone https://github.com/jdunmire/kicad-ESP8266
```

Add ESP8266.lib to the Component Libraries:

eeschema:Preferences->Component Libraries->Add

Add ESP8266.pretty to the Footprint Libraries:

pcbnew:Preferences->Footprint Libraries Wizard

To make the 3d models usable, add the location from step #1 to list of configured paths as ESPLIB. Use a full path. Continuing with the example step #1:
```
kicad:Preferences->Configure Paths->Add

    Name: ESPLIB
    Path: /home/<your_login_name>/kicad/libraries/kicad-ESP8266
```

3D Models

The 3D models were built using OpenSCAD and then colored in Wings3D to produce the VRML (.wrl) format for KiCAD. Wings3D requires a binary STEP format, but OpenSCAD writes an ASCII version. meshconv will convert the ASCII format to a binary format.

Here is the workflow I used:

Use OpenScad to build the model. Export the model as STL.
- Build using F6
- File->Export...->Export as STL...

Use meshconv to translate the file to binary.

$ meshconv -c stl <STL-FILE-FROM-OpenSCAD> -o <FILENAME>

Now open Wings3d and import the the FILENAME.stl as a StereoLithography Binary File (*.stl).
Assign colors.
Export as VRML 2.0 File (*.wrl)
The 3D model probably needs to be scaled to match the footprint. Use the kicad:Footprint Editor:Edit->Edit Properties->3D Settings dialog. For the ESP-12, the Shape Scale X, Y, and Z values are 0.393700.

This repository includes all the intermediate files:

.scad - OpenSCAD model
.stl - OpenSCAD STL
_4wings.stl - STL file converted by meshconv
.wings - Wings3D model
.wrl - VRML model for KiCAD

License

Contact: jedunmire PLUS kicad-ESP8266 AT gmail DOT com

This file is part of kicad-ESP8266.

kicad-ESP8266 is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license visit http://creativecommons.org/licenses/by-sa/4.0/.

kicad-esp8266's People

Contributors

Stargazers

Watchers

Forkers

mohan-klarsys klarsys jneiva08 dirkjankrijnders turboss tannewt bradleyking4 sarfata hexxter dietmar-franken skorokithakis blensonpaul ceremcem mdchaparror aarontc mcqn jueshi mkleinschmidt dfries wangyx0055 longcongduoi hydropwnics mrmoje markrages joshvaldes lexszero manubompella mandris marginallyclever trygvis deadroad marczis jer-wei aleggeup miharix beyondszine montri2025 erlhermit rustamojukas orcema jsdjayanga nightdragon1 rkinotoy branux marclachapelle peekpt gotlaufs esarearthur emtantra shop2007 gusteibolt crisap94 julesverhaeren kisel mstroehle tadas-s thefork robertholzknecht electroniccats safepassguy1 igagis feliperodrigues64 clementleger grey-yibu jdrobotter beno1961 makeuris c0degreen bask73 tinel-c perry-amsterdam phschoen tmaczukin nnarain frederico-betting sigma-random wjhuang3579 linuxman52000 horga83 mzhur horacezh vman45 jpdw kukuhsw mvelthaus djirotechno panyihang yuzhongshanyue hailong123-qu baomin scottjames valhalla-electronic picli3 neferkat kingvei agambier brunoh44 andrewreloaded geversonsto tarekcmahmoud

kicad-esp8266's Issues

Feature Request: KiCad 5 Version

This is a great library, but unfortunately, I could not use them in KiCad 5.0 ( nightly build, Application: kicad
Version: (5.0.0-rc2-dev-744-gdfcdfe91f), release build)). When I tried (in eeschema) , I got an error saying it could not read the lib. If you want more specific information, I will re-install and try again. just let me know what you want to see.

With the coming release of KiCad 5.0, any chance of updating them for this release?

Pin numbers on the ESP-01 part wrong?

Are the pin number on the ESP-01 part wrong? I'm thinking this can not be as this git repository has been active for over a year and I don't see any issues about this. That said, the ESP-01 pictures & diagrams I have found on the web show GND being pin 1. But when I placed the ESP-01 from the newly installed KiCad library GND was on pin 2.

Can we get a 3d model for the NodeMCU?

Would be great to also have a 3d model for the NodeMCU :).

Just the chip

This should also have a footprint and schematic symbol for the two chips (esp8266E and esp8285) without breakout/module board. Simply the bare chips.

kicad doesn't import the module

In CvPcb or PcbNew when opening the libraries dialog i can't import the footprints, since kicad requires a .mod.
I tried renaming the files from _mod to .mod and add the folder as a search path. None worked

Footprints don't show up in browser

Open project, click "PCB Footprint Editor." Click "Select active library" then find "ESP8266" Click "Load footprint from library" then "List all" This results in the message "No footprints could be read from library file(s): in any of the library search paths. Verify your system is configured properly so the footprint libraries can be found." - Everything appears to be installed correctly, and I can use the components in a design, so what have I done wrong? Additionally, in the Library Browser (click "Open footprint viewer") no footprints show up under the ESP8266 library.

This is probably my own fault given that I don't know what I'm doing, but after a few minutes of compare and contrast, other libraries work. I've got this library installed at "Users\me\KiCad\Libraries" as per readme.md (also that spot makes sense to me).

PCB DRC Error: Footprint has malformed courtyard

When I run design rules checker of KiCad PCB Editor I get two error related to the esp8266 footprint:

Footprint has malformed courtyard (not a closed shape)
Footprint has malformed courtyard (self-intersecting)

I'm new in the world of PCB design (so, can I have made some mistake somewhere), especially if I think no one have reported this issue since now.

Thanks!

ESP-12E

Could you add the ESP-12E board?
I want to build a custom dev board and that would be really helpful.
Thank you.

ESP12E : pin mapping

The PIN mapping between the component and the footprint.

esp-m2 (esp8285)

going to add the esp8285?

Doesn't look like this is being maintained anymore. * Link here to fork with some fixes *

Sadly I don't think the original author of this repo is maintaining it any more.
As some of the footprints fail DRC checks on current versions of Kicad, I have forked it and added some fixes:
https://github.com/Basirk/kicad-ESP8266

If anyone else wants to contribute, please do. I'll happily accept pull requests to the fork, but will be mostly trusting that people know what they're doing because I don't really!

Also note that I think the default Kicad footprint library now contains some ESP8266 modules under RF_Module. These weren't suitable for me as I wanted access to the pins on both sides of the board, and the Kicad version only had single-sided SMD.

NodeMCU1.0(12-E) footprint is too large

IMHO, the NodeMCU1.0(12-E) footprint is too large. Aparently this is drawn for a LoLin V3 NodeMCU Board rather than the NodeMCU v1.0.

It's not quiet easy to find the correct dimensions on the web. According to this PDF, the outer board dimensions should be 25.4mm x 48.26mm:
https://github.com/nodemcu/nodemcu-devkit-v1.0/blob/master/NODEMCU_DEVKIT_V1.0.PDF

According to the caliper, my boards have exactly these dimensions.

See pictures of both boards here:
https://blog.squix.org/2015/03/esp8266-module-comparison-esp-01-esp-05.html

ESP8266-12E: Wrong pinout in schematics

Great library, thanks for the amazing work.
There's just one thing I've discovered. The PIN number order from 9 to 22 in the schematics does not correctly match to the one in the footprints.

The datasheet tells that pin ordering is the form of an U. It starts on top left on 1 then goes down the left edge (that part is okay). Then PIN 9 to 14 continue on the bottom edge and then go up again on the right edge from 15 to 22.

Here's the schematics (label ordering is correct, pin numbers are not)

Here's the footprint (numbering is correct, labels are not)

Pinout as it should be (unfortunately rotated by 180°):

Thanks for looking into it.

KiCad library integration

I wonder why haven't you tried to push your symbols, models and footprints to KiCad.

I have interest in using ESP8266 but have not yet designed any circuit with it. I would love to see your models in the KiCad library for easiness of use.

I hope you find the idea appealing!

Nice work ;)

Wrong 3D Model for ESP-12E_SMD.kicad_mod

It looks like the 3D model associated in this footprint is ESP-12.wrl when it should be ESP-12E.wrl.

Caveat: I'm an extremely novice kicad user JUST jumping in to 3D and have no idea what I'm doing. Also, on that subject: this library makes use of "${ESPLIB}" for defining the path to the 3D models. How does that work? Where does it get defined? I've installed this library with a "git clone" to Users/Me/KiCad/Libraries/kicad-ESP8266 (this is windows), and none of the 3D models get found until I manually add them at the footprint level with the absolute path... what am I doing wrong? I'd love a pointer.

Any plans to add ESP-12F?

Any plans to add the ESP 12F?

Do you have in plan to add ESP-02?

ESP-02 is only one (except ESP-01 which is not possible to programming) module which was 2.54mm grid and is possible to use it on breadboard.