• Stars
    star
    212
  • Rank 186,122 (Top 4 %)
  • Language
    JavaScript
  • License
    Apache License 2.0
  • Created over 9 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Command Line Interface for Particle Cloud and devices

npm Build Status License

Particle's full-stack Internet of Things (IoT) device platform gives you everything you need to securely and reliably connect your IoT devices to the web. For more details please visit www.particle.io.

Particle CLI

The Particle CLI is a powerful tool for interacting with your IoT devices and the Particle Cloud. The CLI uses node.js and can run on Windows, Mac OS X, and Linux. It's also open source so you can edit and change it, and even send in your changes as pull requests if you want to share!

Table of Contents

Installing

For end-users, the most up-to-date installation instructions can be found here: macOS / Linux | Windows

Note: On some platforms (e.g. arm), additional manual steps are required:

particle-cli uses npm packages node-usb and node-serialport. On some environments (ie: Raspberry Pi and Apple M1), node-serialport does not provide prebuild environments, so their npm install script relies on creating a prebuild using node-gyp (See node-gyp requirements), and libudev (See node-usb installation. And these must be installed in order for their npm install script to succeed. As well, particle-cli uses dfu-util and openssl.

As an example, to install these dependencies on Raspbian/Debian/Ubuntu:

sudo apt update && sudo apt upgrade
sudo apt install build-essential libudev-dev python3 dfu-util openssl

Getting Started

These next two commands are all you need to get started setting up an account, claiming a device, and discovering new features.

particle setup

Guides you through creating a new account, and claiming your device!

$ particle setup

particle help

Shows you what commands are available, and how to use them. You can also give the name of a command for detailed help.

$ particle help
$ particle help keys

Updating Firmware

Photon/P1/Electron

particle update

If you wish to easily update the system firmware running on your device to a later version, you can use the particle update command. For the exact version it will update to, check the version of the files in the updates folder.

  1. Make sure you have DFU-util installed.
  2. Connect your device via USB, and put it into DFU mode.
  3. Run particle update.

Command Reference

For the full list of commands, please see the CLI command reference.

Known Issues

  • The Wireless Photon Setup Wizard will only automatically switch networks on OS X. Users of other operating systems will need to manually connect their computer to the Photon's Wi-Fi. You will be prompted during the wizard when this is required.

Development

Currently development is supported on macOS only!

Installing

  1. Install Node.js [[email protected] and [email protected] are required]
  2. Clone this repository $ git clone [email protected]:particle-iot/particle-cli.git && cd ./particle-cli
  3. Install external tools: dfu-util and openssl (e.g. brew install openssl)
  4. Install dependencies $ npm install
  5. View available commands $ npm run
  6. Run the tests $ npm test
  7. Run the CLI $ npm start
  8. Start Hacking!

Running

When developing, run individual commands using:

$ npm start -- <command> <options> - e.g. $ npm start -- library view dotstar --readme

Anything after the -- delimiter is passed directly to the CLI (docs).

To test the source as it will be published:

  1. Register the particle command globally: $ npm link
  2. Run commands: $ particle --help (using standard argument formatting)

Testing

The Particle CLI has a number of automated test suites and related commands. The most important are:

  • npm test - run all tests (NOTE: End-To-End tests require additional setup)
  • npm run lint - run the linter and print any errors to your terminal
  • npm run test:ci - run all tests excluding device-dependent end-to-end test as CI does
  • npm run test:unit - run unit tests
  • npm run test:integration - run integration tests
  • npm run coverage - report code coverage stats

All tests use mocha, chai, and sinon with coverage handled by nyc.

We recommend running locally if you can as it greatly shortens your feedback loop. However, CI also runs against every PR and error reporting is publicly available.

Updating system firmware

  • npm run update-firmware-binaries <version> where <version> is the newly released system firmware version like 0.7.0

  • Test on each platform by doing

    # Check old firmware version
    bin/particle.js serial inspect
    
    # Flash new system firmware
    bin/particle.js update
    
    # Verify new firmware version
    bin/particle.js serial inspect
    
  • Do not update the versions or CHANGELOG.md just yet!

  • Commit as something like "adds firmware binaries for 0.7.0" and proceed to release a new CLI version (below).

Releasing a new version

See RELEASE.md.

More Repositories

1

device-os

Device OS (Firmware) for Particle Devices
C++
1,049
star
2

thermostat

A place for all things related to ye olde Spark Thermostat Hackathon
Ruby
717
star
3

spark-server

UNMAINTAINED - An API compatible open source server for interacting with devices speaking the spark-protocol
JavaScript
440
star
4

core

Hardware design files for the Spark Core, a tiny Wi-Fi development kit.
Eagle
367
star
5

sparkjs

DEPRECATED - Use particle-api-js instead
JavaScript
216
star
6

photon

Hardware design files for the Photon, Particle's Broadcom BCM43362 Wi-Fi development kit.
180
star
7

spark-cli

DEPRECATED: Renamed to particle-cli. See https://github.com/spark/particle-cli
JavaScript
160
star
8

docs

Documentation for Particle
JavaScript
143
star
9

particle-api-js

JS Library for the Particle API
JavaScript
121
star
10

spark-protocol

Node.JS module for hosting direct encrypted CoAP socket connections
JavaScript
91
star
11

android-app

Spark Android App
Java
91
star
12

electron

89
star
13

hardware-libraries

Particle parts for computer-aided design (CAD)
81
star
14

shields

Repo for shield files for the Particle boards
C++
70
star
15

spark-sdk-ios

DEPRECATED Particle iOS Cloud SDK. Use -->
Objective-C
52
star
16

ElectronAssetTracker

Library for the Electron Asset Tracker!
C++
52
star
17

awesome-particle

A curated list of awesome things related to Particle
48
star
18

warsting

WarSting: A wardriving Hobbit sword
Arduino
45
star
19

particle-android

Particle Open Source for Android
C
38
star
20

examples

Spark Core app examples to make it easier to rock out with your Spark Core.
Arduino
36
star
21

InternetButton

Library for the Internet Button shield
C++
35
star
22

softap-setup-js

Particle SoftAP Setup for JavaScript
JavaScript
35
star
23

app-notes

Technical application notes for hardware and software designs and best-practices.
32
star
24

local-communication-example

Particle annotated example
JavaScript
32
star
25

boron

Hardware design files for Particle Boron
31
star
26

xenon

Hardware design files for Particle Xenon
28
star
27

uber-library-example

The first Spark firmware library. To exemplify naming conventions and required files.
C++
27
star
28

example-app-ios

Barebones example Swift iOS app demonstrating how to use the ParticleSetup / SDK cocoapod libraries
Swift
25
star
29

socket

Hardware design for the Spark Socket.
25
star
30

argon

Hardware design files for Particle Argon
25
star
31

xmastree

πŸŽ„ Happy Holidays from Particle πŸŽ„
JavaScript
23
star
32

particle-tinker-app-ios

iOS Particle Tinker App
Swift
23
star
33

spark-setup-android

Former home of the Particle Device Setup library for Android
Java
23
star
34

lwip

A fork of https://git.savannah.nongnu.org/git/lwip.git
C
21
star
35

particle-agent

Agent supervising the Particle firmware on the Raspberry Pi
Ruby
21
star
36

particle-cloud-sdk-ios

Official Particle Cloud SDK for iOS
Objective-C
20
star
37

gcc-output-parser

gcc error parsing library
JavaScript
19
star
38

particle-iot.github.io

Spark open source site at http://particle-iot.github.io/
HTML
19
star
39

spark-setup-ios

(DEPRECATED) Spark device setup library - Soft AP Cocoapod/Carthage lib for iOS
Objective-C
19
star
40

google-cloud-datastore-tutorial

A demonstration of how to store Particle device data in Google Cloud Datastore
JavaScript
18
star
41

tracker-edge

Particle Tracker reference application
C
18
star
42

ble-group-library

C++
18
star
43

particle-pi-camera

Repo to host the Particle Pi Camera project
C
14
star
44

beacon-scanner-library

A library for scanning BLE beacons
C++
14
star
45

vorono-iot-lamp

Arduino
13
star
46

cloud-debug

Troubleshooting tool for Particle cellular and Wi-Fi device connectivity
C++
13
star
47

PowerShield

The Power Shield library provides functions to use the on-board MAX17043 fuel gauge via I2C
C++
12
star
48

node-red-contrib-particle-official

Official Node-RED Particle nodes
HTML
12
star
49

particle-windows-sdk

Particle Cloud SDK for Windows apps
C#
12
star
50

rc-car-ios

Spark RC car iPhone app
Objective-C
12
star
51

esp32-ncp-firmware

ESP32 firmware for the Argon
C++
11
star
52

twitter-magnet

C++
11
star
53

tinydtls

C
11
star
54

debugger

Design files for the CMSIS-DAP debugger
11
star
55

nrf5_sdk

C
10
star
56

Particle-PID

PID control library for Particle, adapted from br3ttb/Arduino-PID-Library
C++
10
star
57

mff2-to-4ffnano

Flex PCB design for MFF2 to 4FF Nano SIM card adapter
10
star
58

ethernet-wing

Hardware design files for the Particle Ethernet Wing
9
star
59

electron-powersupply

Place to host the design files for experimental power supply boards for the Electron
Eagle
8
star
60

freertos

https://svn.code.sf.net/p/freertos/code Git mirror
C
8
star
61

ble-gateway-library

A library to aggregate BLE peripheral data
C++
8
star
62

node-mbed-dtls-client

node DTLS client wrapping mbedtls
C++
7
star
63

spark-tinker

Tinker plugin for spark javascript module
JavaScript
7
star
64

docs-tutorials

Tutorials, sample code, and sample designs used in the documentation (docs.particle.io)
7
star
65

wordclock

Arduino
7
star
66

firmware-buildpack-builder

A set of scripts building `buildpack-particle-firmware` Docker image out of `firmware` repository
Shell
7
star
67

rgb-pixel-clock

7
star
68

tracker-hardware

Tracker evaluation board and carrier board public repository for CAD files
7
star
69

particle-photon-setup-ios

Particle device setup library for iOS and Cocoapod & Cathage dependency format
Objective-C
6
star
70

lwip-contrib

A fork of git://git.savannah.nongnu.org/lwip/lwip-contrib.git
C
6
star
71

air-quality-kit

Source for the Particle Air Quality Monitoring Kit
C++
6
star
72

device-os-flash-util

Device OS Flashing Utility
JavaScript
6
star
73

pixel-tweets

Stream tweet events and convert them to pixel data for a Spark Internet Button!
C++
6
star
74

som-eval-board

Hardware repository for the M.2 SoM evaluation board
6
star
75

particle-library-manager

Node library for managing libraries in the cloud and on local disk
JavaScript
5
star
76

particle-usb

A library for accessing Particle USB devices
JavaScript
5
star
77

particle-app-windows

The Particle Tinker app for Windows Phone
C#
5
star
78

google-maps-device-locator-examples

JavaScript
4
star
79

gps-ublox

Support for u-blox NEO-M8U with paired NMEA parser
C++
4
star
80

realtek_ambd_sdk_public

Realtek Ameba-D SDK
C
4
star
81

makerkit

C++
4
star
82

buildpack-hal

Buildpack for modern (HAL) Particle firmware
Shell
4
star
83

particle-windows-devicesetup

Particle Device Setup SDK for Windows apps
C#
4
star
84

buildpack-raspberrypi

Buildpack for Particle firmware running on the Raspberry Pi
Shell
4
star
85

device-os-test-runner

Device OS Test Runner
JavaScript
4
star
86

device-os-protobuf

Message format definitions for Device OS
JavaScript
4
star
87

e-series-evaluation-board

Hardware repository for the E series evaluation board
4
star
88

particle-workshops

Workshops designed to teach the basics of IoT development with the Particle ecosystem
C++
4
star
89

model_gauge

MAX17043 FuelGauge Custom Model Configuration
C++
4
star
90

gsm0710muxer

C++
3
star
91

mesh-rc-cars

Gateway and endpoint firmware for mesh-networked RC cars
C++
3
star
92

windows-device-drivers

USB Drivers for Particle devices
C++
3
star
93

RelayShield

Library for the Photon Relay Shield
C++
3
star
94

binary-version-reader

a node.js module to parse versions and information from system modules and firmware for any particle device
JavaScript
3
star
95

particle-swift

Swift 3.0 Package for interacting with Particle Cloud services
Swift
3
star
96

gps-nmea-parser

Generic GPS NMEA parser for embedded systems (https://github.com/MaJerle/gps-nmea-parser)
C++
3
star
97

firmware-cicd-examples

Example firmware projects with CI/CD using GitHub Actions
C++
2
star
98

softap-emulator-js

implements the device-side of the soft-ap protocol
JavaScript
2
star
99

b-series-rs232

Hardware design repository for B Series to RS232 bridge
2
star
100

cloud

A place to discuss issues, enhancements, features for: API, Cloud Compiler, Web IDE (Build), Webhooks, Console, and Device Setup
2
star