This project is a web-based tool that allows you to send various types of data packets over a serial connection using the Web Serial API. It can be used with a variety of devices that support serial communication, including Bluefruit devices and others.
Currently supports the http://DEVICE_IP/code/ or http://circuitpython.local/code/ based websites for accessing circuitpython devices over web-workflow. Eventually will support all 3 transports (USB/BLE/WebWorkflow)
-- Most of it, but tested ColorPackets and ButtonPackets
- Color Picker: Send color data.
- Control Pad: Send control commands.
- Accelerometer: Send accelerometer data from the device's sensors.
- Terminal: Send AT commands.
- DFU: Send Device Firmware Update packets.
- Security: Send security-related data.
- Read/Write: Send read and write data.
- Notify: Send notification data.
- Scan: Send scan data.
- IO Pin: Send IO Pin data.
- Neopixel: Send Neopixel data.
- String: Send string data.
- Raw Data: Send raw bytes and strings.
- Location: Send location data using manual input or the device's GPS.
- A device (running circuitpython?) that supports serial communication.
- Using web workflow requires any compatible browser
- Using USB-Serial or BLE requires a web browser that supports the Web Serial or BLE API
If you have problems then try a Chromium based web browser (e.g., Chrome, Edge).
See ./examples folder for a Crickit based project that previously required bluetooth
Next is a link to the bookmarklet code which you can right click HERE and choose add to favourites/bookmark,
Or the bookmarklet code to copy and paste into address bar:
javascript:(function() {
var script = document.createElement('script');
script.src = 'https://cdn.jsdelivr.net/gh/tyeth/serialfruit-connect@v0.0.109/src/bookmarklet.js';
document.body.appendChild(script);
})();
(You may need to add the javascript: prefix back into the address bar after pasting the code from above, as browsers remove it as part of keeping you safe - bookmarks are not affected by this protection)
** You may wish to use the tag @main instead of @v0.0.0.1 etc as that will always be the Latest code, but may therefore break! **
-
Color Picker:
- Select a color using the color input.
- Click "Send Color" to send the selected color data.
-
Control Pad:
- Click on the directional buttons (Up, Down, Left, Right) to send control commands.
-
Accelerometer:
- Click "Start/Stop Sending Data" to toggle sending accelerometer data.
-
Terminal:
- Enter an AT command in the input box.
- Click "Send Command" to send the command.
-
DFU:
- Click "Choose File" to select a DFU file.
- Click "Send DFU Packet" to send the DFU data.
-
Security:
- Enter security data in the input box.
- Click "Send Security Packet" to send the data.
-
Read/Write:
- Enter data to read or write in the respective input boxes.
- Click "Read" or "Write" to send the respective packets.
-
Notify:
- Enter notification data in the input box.
- Click "Send Notify Packet" to send the data.
-
Scan:
- Click "Send Scan Packet" to send a scan packet.
-
IO Pin:
- Enter IO Pin data in the input box.
- Click "Send IO Pin Packet" to send the data.
-
Neopixel:
- Enter Neopixel data in the input box.
- Click "Send Neopixel Packet" to send the data.
-
String:
- Enter a string in the input box.
- Click "Send String Packet" to send the string data.
-
Raw Data:
- Enter raw bytes (comma-separated) or a raw string in the respective input boxes.
- Click "Send Raw Bytes" or "Send Raw String" to send the data.
-
Location:
- Enter latitude and longitude manually, or click "Use Current Location" to get the device's current location.
- Click "Send Location" to send the location data.
- Fork the repository.
- Create your feature branch (
git checkout -b feature/YourFeature). - Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/YourFeature). - Open a pull request.
- install mkcert and set system to trust (with --install), a cert will be generated later:
mkcert --install
- install dependencies for updating tags/refs and watchdog server:
pip install bs4 semver watchdog - use
python watching-server.pyor the vscode launch tasks to run python server task and it will copy all /src files and mangle them to localhost - use the bookmarklet code printed in the console at server startup instead, which will be similar to:
javascript:(function(){var script=document.createElement('script');script.src='https://192.168.43.244:4443/localhost-src/bookmarklet.js';document.body.appendChild(script);})();This project is licensed under the MIT License - see the LICENSE file for details.