What's new

 

Updates

SPI DMA callback warning 2024-04-18

Added a warning about not setting the CS pin high in a SPI DMA transfer callback.

B-SoM eval board fix 2024-04-18

The pinout diagram for the M.2 eval board board 60-pin expansion header pin 25 (A4) was missing from the diagram. The tables are text were correct.

M404 certification update 2024-04-18

Certification documents for the M404 include ISED (Canada) individual test reports; previously only the certificate was included.

Community library update 2024-04-18

The community library information in the docs has been updated with any recently updated libraries.

PDM microphone information 2024-04-18

Updated the M-SoM, P2, and Photon 2 datasheets and migration guides to include information about PDM microphones.

Cellular data usage guide update 2024-04-17

Added additional tips to the cellular data usage guide.

STM32 Asset OTA Update 2024-04-16

Updated STM32 Asset OTA example uses a library to make it easier to integrate into your application.

M404 certification update 2024-04-16

Certification documents for the M404 include ISED (Canada).

M404 certification update 2024-04-15

Certification documents for the M404 include CE RED certification and RoHS.

Release note filter 2024-04-12

The release note tool now has an option to filter by device platform.

M524 certification update 2024-04-12

Certification documents for the M524 updated to include CE RED certificate and RoHS.

M404 certification update 2024-04-11

Certification documents for the M404 include an updated PCS certificate and added FCC Part 15B.

Qubitro integration instructions 2024-04-11

Added integration instructions for Qubitro.

M404 certification 2024-04-08

Certification documents for the M404 are now available.

particle.include update 2024-04-04

Updated the example patterns for filename wildcards for particle.include and particle.ignore.

M SoM datasheet 2024-04-03

Added additional RF transmitter information.

particle-api-js duplicate sections 2024-04-02

Removed the duplicate sections from the particle-api-js documentation.

Organization integrations 2024-04-02

Documentation for organization integrations is now available.

M SoM GA 2024-04-02

The M404 and M524 are now generally available (GA).

PHNTRAYNOH deprecation 2024-03-26

PHNTRAYNOH (Photon without Headers, Tray [x50]) is now deprecated. This is the Photon 1, not the Photon 2.

BLE.getProvisioningStatus 2024-03-20

The BLE.getProvisioningStatus method is now documented.

Incorrect LTE M1 bands 2024-03-19

The datasheets for the B402/B404 and BRN402/BRN404 listed the wrong LTE Cat M1 bands. The list of supported bands should be 2, 4, 5, 12, 13.

Particle.subscribe clarification 2024-03-19

Clarified that subscription updates occur only after loop is running.

Device OS 5.8.0 2024-03-16

Device OS 5.8.0 is now in Device Restore USB, Hex Generator, etc.. Also fixed a bug where Device Restore USB and Web Device Doctor returned a "could not put device in DFU mode" error immediately after selecting the device when the device had Device OS 5.7.0 installed on it.

P2, Photon 2, M-SoM baud rates 2024-03-16

On the P2, Photon 2, M-SoM, and Muon UART serial, 2400, 4800, 380400, 460800, baud rates are supported but were not listed.

M SoM pin 45 2024-03-15

M SoM pin 45 is not shared. Pins 43 and 53 are both connected to PB[3], but not pin 45.

Photon 2 and Argon block VUSB clarification 2024-03-15

Updated the block diagram and added text to clarify how VUSB works on the Argon and Photon 2.

Basic plan 2024-03-12

The growth plan is now named the basic plan. The free plan is unchanged.

Tracker Edge ignore() 2024-03-12

Tracker Edge and Monitor Edge ignore(pin_t) may require a cast to avoid an ambiguous declaration error. Example and documentation updated.

Photon 2 and Argon block diagram update 2024-03-12

The block diagram for the Photon 2 and Argon had the diode on VUSB in the wrong location.

Boot mode pin warnings 2024-03-11

The P2 and Photon 2 datasheets now include a warning about boot mode pins (TX, D6, and D7) in the GPIO pin listing.

Wake source clarification 2024-03-11

At least one wake source must be specified for STOP and ULP sleep modes.

Photon 2 migration guide USB 2024-03-11

The Photon 2 migration guides listed the Photon 2 as having a USB C connector, but it has a Micro USB B. The datasheet was correct.

Photon 2 datasheet CHG pin 2024-03-11

The Photon 2 datasheet and Photon 2 from Argon migration guide now has the same warning about the CHG pin as the Device OS firmware API reference. The pin cannot be reliably used.

Logic open beta 2024-03-11

Logic is now in open beta.

Hardware overview page update 2024-02-26

The hardware overview has information about the M-SoM and Muon, and the page should be much easier to understand now.

BLE.scan callback example typo 2024-02-22

The example in for BLE.scan(callback) had an error that prevented compiling.

M-SoM datasheet 2024-02-22

The preliminary M-SoM datasheet and migration guides are now available. The battery calculator and cellular carrier list includes M-SoM now.

Muon datasheet preview 2024-02-22

The Muon datasheet preview is now available.

Pin drive strength P2 2024-02-20

Pin drive strength for the P2 and Photon 2 is now included in the Device OS firmware API documentation and datasheets.

Upload firmware clarification 2024-02-16

When using the upload product firmware cloud API to upload a .zip file containing Asset OTA images, it must be set as type application/json.

BLE.setPairingPasskey 2024-02-16

Clarified the use of the pass key parameter to BLE.setPairingPasskey.

CLI updates 2024-02-16

Updates for Particle CLI documentation for CLI version 3.21.0.

Tracker cmd additions 2024-02-15

Added information about the cmd handlers in Tracker Edge and Monitor Edge for the get_cfg and reset_to_factory commands.

Tracker edge events 2024-02-13

Added links to the Tracker Edge, Monitor Edge, and Store and Forward documentation to the published event reference in the cloud API reference.

B-Series eval power power 2024-02-13

Clarified the power supply options for the B-Series eval board.

setDeviceName maximum length 2024-02-12

The practical limit for the device name is 14 characters to fit in the default advertising message.

Enterprise Wi-Fi 2024-01-31

Clarify that enterprise Wi-Fi is not supported on the P2/Photon 2.

Connection management 2024-01-30

Automatic connection management documentation is now available. The feature is available in Device OS 5.7.0.

Monitor One datasheet battery warnings 2024-01-29

Added additional warnings related to batteries to the Monitor One datasheet.

ESP32 Wi-Fi test binaries 2024-01-25

Added a link to the test tools binary file to the Argon ESP32 certification page.

JSON tool 2024-01-24

There's always been a JSON verifier and encoder in the JSON docs but now it's available as standalone JSON tool making it easier to find. There is also a new option to convert a JSON object into a C++ string.

Singleton class generator tool 2024-01-24

There's always been a tool to create a single class template (optionally with threading and locking), but it was hidden in the singleton docs but now it also exists as a standalone singleton class generator tool making it easier to find.

Device OS 5.7.0 2024-01-24

Device OS 5.7.0 is now available in Device Restore DFU, Device Restore JTAG, hex file generator, and release note viewer.

B402MEA deprecated 2024-01-22

The SKU B402MEA is deprecated. The recommended replacement is B404XMEA.

SoM first board and Basic SoM fix 2024-01-22

M.2 pin 40 should be D3 and M.2 pin 42 should be D2. These were reversed previously, however these sample boards do not use the pins.

Scrolling fix in Device OS API reference 2024-01-18

Fixed a longstanding bug where if the section you opened in the Device OS firmware API reference was shorter than the height of your window, the next section might not load automatically. Scrolling down would not load it, either.

Fixed navigation on some pages 2024-01-18

Fixed a bug where if a page had no L2 headers, no navigation would be shown even if it had L3 headers. One example was the Workbench FAQ.

WiFi.setCredentials for P2/Photon 2 2024-01-16

Documented the number of Wi-Fi credentials for the P2/Photon 2, which is the same as the Argon (10).

Static network interface example fixes 2024-01-12

In several locations in the Device OS firmware API reference, when .source(NetworkInterfaceConfigSource::STATIC) was specified, there was a semicolon at the end of the line which should not be there.

Added documentation for WiFi.getAntenna 2024-01-10

The WiFi.getAntenna function was not previously documented (but present since 0.8.0-rc.2).

Opening a hidden section 2024-01-09

If you try to open a link to a header in a section hidden by a disclosure triangle, or click on a left-hand navigation to one, the section is now opened first. Before, nothing would happen.

Using Logic for data transformation 2024-01-08

New example of using Logic for data transformation.

Added a link from the configuration schema tool to custom schema instructions.

Ethernet Featherwing deprecation 2024-01-05

The Ethernet Featherwing for Gen 3 devices is now deprecated and no longer available in the retail and wholesale stores.

Clarify size of built-in types 2024-01-04

The size of double, etc. are the same across all platforms, not just the Photon and Electron.

Clarify use of PMID on E404X 2024-01-03

Clarified that PMID should not be used on the E404X.

Updated library database 2024-01-02

Updated the community library database with any recent versions, also updated the compile targets so every library example has been tested with 5.6.0 and 4.2.0 on an assortment of platforms.

Clarify use of Tracker SoM PMID pin 2023-12-23

The PMID pin on the Tracker SoM should be left unconnected in normal use.

Updated B524 band power information 2023-12-20

Clarified the band power table for the B524.

Ledger documentation 2023-12-29

Added preliminary documentation for Ledger beta.

Photon 2 schematic 2023-12-19

Added Photon 2 schematic to the datasheet.

Monitor One 404 certification 2023-12-18

Certification documents for Monitor One (404) are now available.

In document search results 2023-12-08

Clicking on a search result now displays a in-document search results panel with the sections that match your query. This is especially useful for long pages where it's not clear where you should scroll to. For example API users.

Device OS 5.6.0 2023-12-08

Device OS 5.6.0 is now available in Device Restore DFU, Device Restore JTAG, hex file generator, etc.. Release notes are updated in the docs release note viewer.

Improved search result display 2023-12-06

When you click on a search result and the search query is present in a header in the page, it will now be scrolled into view. This previously worked on the Device OS API reference, but now it works on all pages.

Copying and moving integrations 2023-12-06

Added instructions for copying and moving integrations.

BLE.disconnect warning 2023-12-05

Added a warning for BLE.disconnect that it cannot be called from a BLE callback.

Software timer note 2023-12-05

Added a note the software timers reference about how certain timer semantics are undefined by the underlying FreeRTOS timers.

Permanent roaming Oman 2023-12-04

Oman has been added the list of countries that may encounter permanent roaming restrictions.

SKU deprecation 2023-11-29

The B523MEA and ARGNTRAY50 are deprecated. They were previously NRND until the stock was depleted, and that has occurred.

New search 2023-11-28

The new docs search is now available by clicking on the magnifying glass icon in the top navigation menu.

  • Vastly improved result quality.
  • Clicking on a link then using Back brings you back to the search results. A checkmark next to the item shows which ones you've already visited in this session.
  • Closing the search overlay and opening it again brings back your last search results.
  • Search is now powered by Google but requests are anonymous, not tagged with your Particle account or Google account.

T-Mobile USA LTE Cat M1 2023-11-28

T-Mobile's support for LTE Cat M1 (not just LTE Cat NB IoT) in the United States is now official so the footnote has been removed.

Web device doctor antenna option 2023-11-27

The web device doctor, when used with the P2 and Photon 2, now has an option in Advanced Options for selecting the Wi-Fi antenna (internal, external, or leave unchanged).

Monitor One GA 2023-11-21

The Monitor One (MON404E01C01KIT) is now generally available.

Import devices 2023-11-20

Fixed a bug in the Import devices tool where the device was marked as development if the checkbox was unchecked instead of checked.

Tracker datasheet update 2023-11-20

Added link to footprint Eagle CAD library, and also information on the restrict areas under the SoM to the Tracker SoM datasheet.

Updated SKU status 2023-11-16

SKU Description Old New
ARGN-H Argon [x1] NRND Deprecated
PHN2MTY Photon 2, Tray [x50] Beta GA

Ethernet.ready behavior 2023-11-16

Updated the description for Ethernet.ready(). On isolated Ethernet, it does not return true, because ready implies that the connection is ready to be used as a cloud connection, and isolated networks can't be used as the cloud connection.

Windows 10 device drivers 2023-11-16

There is a new guide for troubleshooting Windows 10 device driver issues.

If you are experiencing these problems you may have a driver issue:

  • No serial device identified in the web-based tools despite using a current version of Chrome or Edge.
  • particle serial list returns no results.
  • dfu-util -l returns no devices.

Particle CLI and Mac with Apple silicon 2023-11-16

If you have a Mac with Apple silicon (M1, M2, M3, ...) and wish to use the Particle CLI natively (not in a Rosetta terminal), see Particle CLI and Mac with Apple silicon.

Ethernet isolated LAN 2023-11-15

There are now additional instructions and a firmware example for using Ethernet with a static IP address and an Isolated LAN and using cellular for the cloud connection.

RS485 pin names 2023-11-14

Renamed RS485 pins A and B instead of P and N in the Monitor One Datasheet and Quickstart page.

What's new page 2023-11-14

New What's new page (this page) lists what's new in the Particle docs!

Logic beta docs 2023-11-13

Logic is a serverless computing platform to host the business logic of an IoT product by running scripts in response to events being emitted from devices. Logic beta documentation is now available.

Classroom setup 2023-11-13

A new page for Classroom setup has tips for using Particle devices in classrooms.

Datasheet full pin details 2023-11-13

Added a full pin details listing to the P2, Photon 2, BRN404X, B404X, B524, datasheets. The migration guides had these, but the actual datasheets did not. The detail listing includes every interface and feature of each pin, sorted by pin, for example this listing for the P2.

Designing on Particle video descriptions 2023-11-09

Added a short description before each Designing on Particle video on the video home page.

Device Restore USB fix for P2 with 5.3.0 2023-11-09

Fixed a bug in Device Restore USB on the P2 and Photon 2 (RTL872x) where if both prebootloader-part1 and bootloader required an upgrade, the bootloader might not upgrade (even with the flash even if version unchanged option is set). This was most noticeable if upgrading a P2/Photon 2 to 5.3.0 with no Wi-Fi credentials so the bootloader would not upgrade OTA.

Documentation for analogSetReference 2023-11-08

Documented analogSetReference() and analogGetReference(), added in 5.3.0 and 4.1.0.

New community integration: ilert 2023-11-08

New community integration: ilert, an incident response platform.

Configuration schema documentation 2023-10-31

All fields in the Tracker Edge and Monitor Edge configuration schemas are now included in the docs. In addition to the longer explanatory text for some tabs in the console, there's now a table format listing of everything in the schema that's generated automatically.

Australia and New Zealand 2G/3G sunset 2023-10-31

Updated 2G/3G sunset information for Australia and New Zealand.

Schematic viewer (beta) 2023-10-14

In the M.2 eval board datasheet, there's a new experimental schematic viewer. You can click on the image, and then zoom in, pan, and print from the expanded view. Known bug is that some text appears mirrored when it should not be.

Edge off-the-shelf release tool 2023-10-25

Monitor Edge off-the-shelf release tool! There's also a similar tool for Tracker Edge. This tool will automatically handle downloading an Edge release and upload it as product firmware. It can also update the configuration schema and view release notes for Edge versions.

Route package protection 2023-10-19

New shipping FAQ for Route package protection.

P1MOD10 deprecation 2023-10-18

The P1 module in strips of 10 is deprecated. All existing stock has been sold and no more will be available.

New project template 2023-10-17

The Create New Project option in Workbench has a new style! See the documentation for the new project template.

Asset OTA community page 2023-10-06

Updated the Asset OTA community examples page. They're now directly included in the docs instead of being links.

Community integrations Tulip and Blynk 2023-10-06

  • Tulip
  • Blynk now has instructions for using Blynk blueprint, which greatly simplifies the process.

Workbench installation chagne 2023-10-04

Updated the installation instructions for Workbench to use the standard VSCode installer.

Updated Asset OTA docs 2023-10-03

Updated Asset OTA page includes additional material and a FAQ with many more technical details.

Device Restore USB and Monitor Edge v2 2023-09-30

Device Restore USB now has an option for Monitor Edge v2.

Serial number docs 2023-09-29

New page that discusses serial numbers and how to use them to map serial number prefixes to SKUs. There's also a big table of SKU to prefix and prefix to SKU.

BRN310KIT deprecation 2023-09-21

The stock of BRN310KIT (Boron 2G/3G) has been sold and will no longer be manufactured. The 2G/3G cellular modem on the BRN310 is no longer available.

Number of hardware breakpoints 2023-09-19

Documented the number of hardware breakpoints (2 on RTL872x and 4 on nRF52) in the Workbench docs.

Device restore hex files for 5.5.0 2023-09-18

There was a problem with the device restore hex files for Device OS 5.5.0 that has been corrected.

Left navigation improvements 2023-09-15

On wider windows, the left navigation is now wider, making more of the content readable. Also a number of items in the troubleshooting menu now have shorter names.

Asset OTA documentation 2023-09-13

Documentation for Asset OTA is now available.

Device Restore USB now supports the Monitor One 2023-09-11

Device Restore USB now supports the Monitor One. You can also select the Tracker Edge or Monitor Edge version separate from the version of Device OS you want to install.