git.gir.st - hardpass.git/blame_incremental - kicad/hardpass-pcb/kicad-ESP8266/README.md

... / ...

Commit	Line	Data
	1	kicad-ESP8266 - a library for KiCAD
	2	=====================================
	3	This project has both schematic symbols, footprints, and 3d models for
	4	ESP8266 based modules. It is a work-in-progress. Additions and
	5	corrections are welcome. Enter a pull request or file an issue on
	6	GitHub.
	7
	8	The present modules are:
	9
	10	* ESP-01 - Note that there are two versions of this module available on
	11	open market. The schematic symbol is for the `v090` version
	12	which is probably the same as the `v080`. There is an older
	13	version that does not include any GPIO signals. The footprint
	14	is the same for all of the ESP-01 modules.
	15
	16	* ESP-12 - This is includes an alias part, ESP-07v2, that is suitable
	17	for the 16 pin variant of the ESP-07. Note that there is a 14
	18	pin version of the ESP-07 that has different signals and
	19	pinout. The footprint for the ESP-12 (and ESP-07v2)
	20	elongated through-hole pads to match those modules.
	21
	22	* ESP-201 - This is a 26 pin module with pins on 0.1 inch spacing. I
	23	could not find any official measurements for the pin
	24	locations so the footprint was created from empirical
	25	measurements on the unit I have.
	26
	27	* ESP-12E - This is for the 22 pin variant of the ESP-12. Though all the
	28	esp-12 signals are in the same place on ESP-12E, pin numbers
	29	have changed.
	30
	31	There are 3d models for the ESP-12 and the ESP-07v2.
	32
	33	WARNINGS
	34	---------
	35	1. The symbols, footprints, and 3d models have not been tested. They are
	36	based on published images and measurements on individual samples.
	37
	38	2. The `.dcm` file contains HTML links to information on sites I used
	39	when creating this library, however I do not have any control over
	40	the sites themselves. Follow the links with caution.
	41
	42	3. This library distributed in the hope that it will be useful,
	43	but __WITHOUT ANY WARRANTY; without even the implied warranty of__
	44	__MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE__.
	45
	46
	47	Use
	48	---
	49	1. Clone this archive to a convenient location on your computer. These are
	50	the commands I use on Linux to create a copy in
	51	`~/kicad/libraries/kicad-ESP8266`:
	52
	53	mkdir -p ~/kicad/libraries/
	54	cd ~/kicad/libraries/
	55	git clone
	56
	57	2. Add `ESP8266.lib` to the Component Libraries:
	58
	59	eeschema:Preferences->Component Libraries->Add
	60
	61	3. Add `ESP8266.pretty` to the Footprint Libraries:
	62
	63	pcbnew:Preferences->Footprint Libraries Wizard
	64
	65	4. To make the 3d models usable, add the location from step #1 to list
	66	of configured paths as `ESPLIB`. Use a full path. Continuing with
	67	the example step #1:
	68
	69	kicad:Preferences->Configure Paths->Add
	70
	71	Name: ESPLIB
	72	Path: /home/<your_login_name>/kicad/libraries/kicad-ESP8266
	73
	74
	75	3D Models
	76	---------
	77	The 3D models were built using [OpenSCAD](http://www.openscad.org/) and
	78	then colored in [Wings3D](http://www.wings3d.com/) to produce the VRML
	79	(`.wrl`) format for KiCAD. Wings3D requires a binary STEP format, but
	80	OpenSCAD writes an ASCII version.
	81	[meshconv](http://www.cs.princeton.edu/~min/meshconv/) will convert the
	82	ASCII format to a binary format.
	83
	84	Here is the workflow I used:
	85
	86	1. Use OpenScad to build the model. Export the model as STL.
	87	* Build using F6
	88	* File->Export...->Export as STL...
	89
	90	2. Use `meshconv` to translate the file to binary.
	91
	92	$ meshconv -c stl <STL-FILE-FROM-OpenSCAD> -o <FILENAME>
	93
	94	3. Now open Wings3d and import the the `FILENAME.stl` as a
	95	_StereoLithography Binary File (*.stl)_.
	96
	97	4. Assign colors.
	98
	99	5. Export as _VRML 2.0 File (*.wrl)_
	100
	101	6. The 3D model probably needs to be scaled to match the footprint. Use
	102	the `kicad:Footprint Editor:Edit->Edit Properties->3D Settings`
	103	dialog. For the ESP-12, the `Shape Scale` X, Y, and Z values are
	104	0.393700.
	105
	106	This repository includes all the intermediate files:
	107
	108	* `.scad` - OpenSCAD model
	109	* `.stl` - OpenSCAD STL
	110	* `_4wings.stl` - STL file converted by `meshconv`
	111	* `.wings` - Wings3D model
	112	* `.wrl` - VRML model for KiCAD
	113
	114
	115	License
	116	-------
	117	Copyright 2015 J.Dunmire
	118
	119	Contact: jedunmire PLUS kicad-ESP8266 AT gmail DOT com
	120
	121	This file is part of kicad-ESP8266.
	122
	123	kicad-ESP8266 is licensed under the Creative Commons Attribution-ShareAlike
	124	4.0 International License. To view a copy of this license visit
	125	http://creativecommons.org/licenses/by-sa/4.0/.