edison-js / edison

💡Edison can controll microcomputer with TypeScript and React💡

Edison

Edison can control microcontroller board with TypeScript or JavaScript!

Documentation

Our documentation site is here!

If you have not yet installed the Arduino IDE ?

please click on the official site and install it.

How to use in WSL

Please read this article.

Installation

Install Edison your project

npm install edison

or

yarn add edison

Getting Started

import { Board, Button, Led, render } from "edison"
import React from "react"

const App: React.FC = () => {
  return (
    <Board port={'/dev/ttyUSB0'}> // Please replace with your port
      <Led
        pin={13}
        blink={500}
      />
    </Board>
  )
}

render(<App />)

Contributing

We love collaborating with folks inside and outside of GitHub and welcome contributions!

👉 Discord

edison's Issues

LED func

The data returned from Arduino may return only f7 at the end if it is not combined.

If two input devices are used, one of them will not work.

(exanple)

import { Board, Button, Led, render } from "edison"
import React from "react"

const App: React.FC = () => {
return (
    <Board port={'/dev/ttyUSB0'}>
      <Button
        pin={9}
        onPress={handlePress}
        onRelease={handleRelease}
      >
        <Led
          pin={5}
          isOn={isOn}
        />
      </Button>

      <InfraredObstacleAvoidance
        pin={12}
        onPress={handlePress1}
        onRelease={handleRelease1}
      >
        <Led
          pin={13}
          isOn={isOn1}
        />
      </InfraredObstacleAvoidance>
    </Board>
  )
}

render(<App />)

import error

Error when testing with Vitest

Error: Cannot find module '/home/runner/work/memorial-cycle/memorial-cycle/server/node_modules/edison/dist/esm/utils/board' imported from /home/runner/work/memorial-cycle/memorial-cycle/server/node_modules/edison/dist/esm/index.mjs

setting vite.config.ts

add ultrasonic sensor

Ultrasonic sensors can send ultrasonic waves and measure distance in the time it takes to receive them.
However, JS(TS) may not know how to measure microseconds accurately and may not be able to obtain the correct distance.

Please find a way to make it work correctly.

add RGB-LED(full-color)

add RGB-LED(full-color) on Arduino Uno R3

Add error handling to components other than parent and child

import React from 'react'
import { useState } from 'react'
import { Board } from '../utils/Board'
import { render } from '../rendere/render'
import { Button } from '../components/input/Button'
import { Led } from '../components/output/Led'

const App: React.FC = () => {
  const [isOn, setIsOn] = useState(false)
  const [isOn1, setIsOn1] = useState(false)

  return (
    <Board port={'/dev/ttyUSB0'}>
      <Button
        pin={8}
        triggered={() => setIsOn(true)}
        untriggered={() => setIsOn(false)}
      >
        <Led
          pin={13}
          isOn={isOn}
        />
      </Button>
      <Button
        pin={12}
        triggered={() => setIsOn1(true)}
        untriggered={() => setIsOn1(false)}
      >
        <Led
          pin={4}
          isOn={isOn1}
        />
      </Button>
    </Board>
  )
}
render(<App />)

Error handling for the above code that can manipulate relationships other than parent-child if setIsOn and setIsOn1 of triggered are swapped.
if change the handle "isOn" and "isOn1" state, you can controll led state other than parent and child components.

Add ESP32 and function

・Enables Internet communication instead of serial port communication

Support Arduino NANO Every

• The MANUFACTURER is not Arduino even if it is a legitimate product (friendlyName contains Arduino).
• The hall sensor responds twice at one time, whether it is because I am using connectManual in the above response or because the sensor is over-reacting.

Destroy cjs

Allows operation via declarative UI

Currently, Edison can be operated with procedural processing.
In the future We would like to be able to operate Edison with a declarative UI.

We need someone to help us. We imagine the following code.

Add Infrared Obstacle Avoidance

Supports infrared sensors.
The necessary methods are read for now to prepare "on" and "off" events.

Add Contributing.md file

I suggest adding a contributing.md file to the project. You can assign this task to me, and I will create the file

Add a repository information about

Suggestions

I propose adding a brief description of the repository's functionality and a direct link to the documentation (https://edison-js-document.vercel.app/) on the "About" page. This will provide a clearer understanding of the repository's purpose and offer easy access to the documentation.

Here is the suggestion for bio

• TypeScript for Arduino
• Arduino programming with TypeScript

Feel free to adjust the bio as needed; these are just suggestions to provide more context about what the repository offers.

Add test with Vitest

There are not test code on edison.
Please add test code to use Vitest.
https://vitest.dev/guide/

Error on input sensor

The infrared sensor is working properly, but the program is not returning the correct value.

import { SerialPort, attachHallEffectSensor, attachLed, board } from "edison";

board.connectManual("/dev/ttyUSB0");

board.on("ready", (port: SerialPort) => {
  console.log("Board is ready!");
  const led1 = attachLed(port, 13);

  const infraredObstacleAvoidanceSensor = attachHallEffectSensor(port, 3);
  infraredObstacleAvoidanceSensor.read("on", () => {
    led1.on();
    console.log(1);
  });
  infraredObstacleAvoidanceSensor.read("off", () => {
    led1.off();
    console.log(0);
  });
});

In the above code, when the sensor is on, the value 0 may be output.

Add joystickSensor

For joystick implementation.
・Multiple control of analog pins.
・Get analog messages on a pin-by-pin basis
・Built-in Buttons