p5bots - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #llm #golang #machine-learning #linux #awesome #cli #awesome-list #pytorch #openai

p5bots

(★ 198)

Use your microcontroller with p5.js

파일 탐색기

최종 버전 다운로드 (.zip)

- - browserify.js
- - knock.png
  - led.png
  - motor.png
  - potentiometer.png
  - rgb.png
  - servo.png
  - simple_button.png
  - temp.png
  - tone.png
- - p5.dom.js
  - p5.dom.min.js
  - p5.js
  - p5.min.js
  - p5bots.js
  - p5bots.min.js
- HelloWorld.md
- index.html
- README.md
- how-it-works.png
- rgb_led.png
- p5.dom.js
- p5.dom.min.js
- p5.js
- p5.min.js
- p5bots.js
- p5bots.min.js
- - app.js
  - README.md
- - .npmignore
  - app.js
  - package.json
  - README.md
- .jshintrc
- - bind.js
  - chai.js
  - mocha.js
- .jshintrc
- mocha.css
- test-minified.html
- test.html
.editorconfig
.gitignore
.jscsrc
.jshintrc
CONTRIBUTING.md
Gruntfile.js
license.txt
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/sarahghp/p5bots

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd p5bots

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Welcome to p5bots!

* [How Does This Work?](#how-does-this-work)
* [p5.Serial](#p5serial)
* [p5.Board](#p5board)
* [Getting Started](#getting-started)
* [Finding Informataion](#finding-information)  
* [Issues](#issues)
* [Contributing](#contributing)

## How Does This Work?

p5.bots is a library to facilitate communication between [p5.js](http://p5js.org/) running in your browser and a microcontroller* running [Firmata](https://github.com/firmata/arduino)**.

<small>
```
* The library has been tested on Arduino Unos, but should work on anything running Firmata.  
** The serial API does not depend on Firmata.
```
</small>

To do this, it uses the `socket.io` library and `node.js` to send messages between the two devices, in a language each device can understand.

This way, you can click on a sketch to light an LED or use temperature data to drive a sketch — or more.

![diagram of client, server, and microcontroller](https://raw.githubusercontent.com/sarahghp/p5bots/master/img/how-it-works.png)

p5bots comprises two sets of files: the client file, called `p5bots.js`, which is included in the `index.html` along with `p5.js` and your sketch; and the server files, called `p5bots-server`, which can be downloaded from [npm](https://www.npmjs.com/package/p5bots-server).

## p5.Serial
p5bots has a [`p5.serial` method](src/client/README.md#serial) that can be used in combination with an Arduino sketch listening for serial, much in the same way the Processing serial library can.

For more details on this module, see [serial in the API reference](src/client/README.md#serial).

If you use serial only, you do not need to install Firmata on your board.

## p5.Board
The majority of p5bots functionality lives within `p5.board`. Inspired by [Johnny-Five](http://johnny-five.io/), p5.board provides a number of hardware-specific methods in addition to plain digital, analog, and pwm read/write methods.

Details for these methods, plus examples can be found in the module pages. Example sketches and hardware diagrams are also available in [the examples directory](examples).

## Getting Started
Ready to go? Good entry points include:
* [the Hello, World tutorial](examples/HelloWorld.md)
* [checking out examples, say for RGB LEDs](https://github.com/sarahgp/p5bots/tree/master/examples#rgb-write)
* reading about [the client API](src/client/README.md), which lists the methods you can use in your p5 code and covers setting up in detail, and [p5bots-server](https://github.com/sarahgp/p5bots/tree/master/src/p5bots-server)
* or, [heading over to p5.js to learn more about the drawing library](http://p5js.org/)

## Finding Infomation
Detailed explanations of functionality have been broken up by subject:
  - Getting set up and using the library with p5.js: [p5.bots API](src/client/README.md)  
  - Setting up and testing the server files: [p5.bots server](src/p5bots-server/)
  - Examples showing p5.bots alongside p5 functions: [examples](examples)

## Issues
[Report issues in this repo.](https://github.com/sarahgp/p5bots/issues)

## Contributing
Want to fix an issue you've identified? Looking to create some functionality we have yet to add? Check out  [CONTRIBUTING.md](https://github.com/sarahgp/p5bots/blob/master/CONTRIBUTING.md).

## License
[LGPL](license.txt)