README

Pinout可以从JSON文件中方便地渲染集成电路引脚图。

安装

$ composer require neuronlight/pinout

通过浏览到/vendor/neuronlight/pinout/examples/index.php来测试安装

您应该会看到一个为PIC12F675微控制器生成的引脚图。

简单使用

在您的网页中包含JavaScript

<script type="text/javascript" src="/vendor/neuronlight/pinout/pinout.js"></script>

要使用JSON渲染引脚图，请使用具有data-device属性的元素

<div data-device="pic12f675"></div>

其中（在本例中）pic12f675是定义设备的JSON文件的文件名（无.json扩展名 - 虽然可以包含它）。

您还需要包含jQuery；本地或通过许多CDN之一

定义设备

设备JSON文件的形式

{
	"name": "Serial Infrared Decoder",
	"description": "Serial Infrared Decoder based on PIC12F675 8-Bit Microcontroller",
	"package-type": "SDIP",
	"pin-count": 8,
	"pinout": {
	    "undefined": "NC",
		"pins": {
			"1": {
				"name": "VDD",
				"signal-direction": "none",
				"description": "Positive supply"
			},
			"2": {
				"name": "IR IN",
				"signal-direction": "in",
				"description": "Infrared module input"
	        },
			"3": {
				"name": "IR IN",
				"signal-direction": "in",
				"description": "Infrared module input"
	        },
			"4": [
					{
						"name": "MCLR",
						"inverted": true,
						"signal-direction": "in",
						"description": "Master clear"
					},
					{
						"name": "VPP",
						"signal-direction": "in",
						"description": "Programming voltage"
					}
			],
			"5": {
				"name": "Serial Out",
				"signal-direction": "both",
				"description": "Serial data output"
	        },
			"8": {
				"name": "VSS",
				"signal-direction": "none",
				"description": "Ground reference"
			}
		}
	}
}

当前支持的包类型有DIP、PDIP、CERDIP、SDIP和SPDIP。

（定义为DIP尺寸的、引脚少于24个的设备被渲染为SDIP）

更改图的外观

该图使用默认配置文件中的参数渲染

{
	"color": "000",
	"background": "fff",
	"width": 640,
	"height": 480,
	"scale": 10
}

可以通过两种方式之一覆盖某些参数或全部参数。

1. 可以创建一个替代配置文件（命名为pinout_config.json），并将其放置在设备JSON文件相同的目录中（以这种方式定义的参数将覆盖默认配置文件中定义的参数）

2. 可以添加其他属性到HTML元素中（以这种方式定义的任何参数都将覆盖任何配置文件中定义的参数）

支持的元素属性有

data-width - 图表宽度（像素）

data-height - 图表高度（像素）

data-scale - 图表比例（每毫米像素数）

data-color - 图表颜色（十六进制M、RGB或RRGGBB格式）

data-background - 背景颜色

直接使用

可以直接调用设备图像。例如，通过以下形式调用示例图像：

/vendor/neuronlight/pinout/pinout.php?f=/vendor/neuronlight/pinout/examples/pic12f675.json&w=600&h=300&c=f40

在直接调用时可以省略文件参数；设备JSON作为名为'dev'的POST参数发送。以这种方式调用时，外观只能通过$_GET参数从默认配置文件中定义的外观更改（即不会加载自定义配置文件）。

实验者

包含了一个基本的工具，可以在/vendor/neuronlight/pinout/examples/experimenter.php中实验引脚图功能（需要html5浏览器）。

分享并享受。