Code Monkey home page Code Monkey logo

docs's Issues

Connecting Your Device

  • Add the link to the new Particle tinker app in the "Particle App for Photon" section
  • Make any device-specific changes to the Connect Your Device page for Core and Photon

Sparticle Changes

  • Getting Started: Spark Core App > ???
  • Getting Started: Spark Cloud > ???
  • Examples: api.spark.io > ???
  • Examples: Spark.variable > ???
  • Javascript SDK: SparkJS > ???
  • Javascript SDK: removeCore, etc
  • Javascript SDK: var spark, etc
  • IFTTT: Spark.publish, Spark.function, etc
  • Webhooks: all technical terms, including those listed above (Spark Cloud, etc)

Javascript SDK

  • Update any changes in npm packages or Spark JS functions to reflect particle
  • Change out any images to be Particle-specific instead of Spark specific

Open Datasheet Errata

Datasheet errata will be added to this issue when found. Datasheets will be updated with the listed version after items are checked off. Some errata may persist between revisions, and they will be moved up to the next proposed revision.

E Series Datasheet (v002) - Not Released Yet

  • Mention the use of optional SPI FLASH and the associated GPIO dependencies.
  • Clarify on the use of the GND pads on the bottom
  • Mention operation in below 0C temperatures for LiPo batteries

Photon Datasheet (v016)

  • Updated External Coexistence Interface section (currently unsupported)

P1 Datasheet (v010)

  • Change "Paid tiers of Particle Cloud start when you create a product with more than 25 devices" to say "Particle provides free access to the Particle Cloud for prototyping and paid tiers for production".
  • Updated External Coexistence Interface section (currently unsupported)

P1 Datasheet (v009)

  • Added part number for 1MB external SPI flash (MX25L8006E)

P1 Datasheet (v008)

  • EEPROM emulation bank 2 (64 KB) - remove only 16k used
  • Replace STM32 pin names with Particle/Wiring API names to keep everything intuitive and high level. Leave STM32 pin numbers for deep dives. #545
  • Make Image of P1 Block Diagram Snazzy
  • CAN bus pins should be noted as 3.3V tolerant (technically they are 5V tolerant on the RX but since you wouldn't operate them with a 5V transceiver it's proper to classify them as 3.3V)
  • Fix and clarify pin descriptions #399 (make sure to review P1 and Photon datasheets as well)
  • Add note to clarify why MICRO_SPI1_SS is not hooked up to DAC/A6 (PA4) #469
  • update DCT Layout https://docs.particle.io/datasheets/p1-datasheet/#dct-layout notably adding radio_flags, and any other new sections.
  • JTAG pin P1 module number is wrong. "D4 JTAG_TDO PB3 54 MICRO_JTAG_TDO Floating" should be "D4 JTAG_TDO PB3 52 MICRO_JTAG_TDO Floating" (54 -> 52)
  • Add warning about powering the Photon from long wires on USB and VIN, and give advice on what components can be added externally to mitigate this. From Richtek datasheet:

When a ceramic capacitor is used at the input and the power is supplied by a wall adapter through long wires, a load step at the output can induce ringing at the input, VIN. At best, this ringing can couple to the output and be mistaken as loop instability. At worst, a sudden inrush of current through the long wires can potentially cause a voltage spike at VIN large enough to damage the part

Photon Datasheet (v015)

  • EEPROM emulation bank 2 (64 KB) - remove only 16k used
  • Add link to power pin limits. #556
  • Replace STM32 pin names with Particle/Wiring API names to keep everything intuitive and high level. Leave STM32 pin numbers for deep dives. #545
  • Memory Map: Rename device_id to device_code and add device_id to DCT layout
  • CAN bus pins should be noted as 3.3V tolerant (technically they are 5V tolerant on the RX but since you wouldn't operate them with a 5V transceiver it's proper to classify them as 3.3V)
  • Fix and clarify pin descriptions #399 (make sure to review P1 and Photon datasheets as well)
  • update DCT Layout https://docs.particle.io/datasheets/photon-datasheet/#dct-layout notably adding radio_flags, and any other new sections.
  • Add warning about powering the Photon from long wires on USB and VIN, and give advice on what components can be added externally to mitigate this. From Richtek datasheet:

When a ceramic capacitor is used at the input and the power is supplied by a wall adapter through long wires, a load step at the output can induce ringing at the input, VIN. At best, this ringing can couple to the output and be mistaken as loop instability. At worst, a sudden inrush of current through the long wires can potentially cause a voltage spike at VIN large enough to damage the part

Electron Datasheet (v005)

  • Replace STM32 pin names with Particle/Wiring API names to keep everything intuitive and high level. Leave STM32 pin numbers for deep dives. #545
  • How to power the Electron without a battery.
  • Describe the usage of the VBAT to 3V3 bridge on the bottom. Update link to instructions for removing VBAT to 3V3 jumper located here: https://docs.particle.io/datasheets/electron-datasheet/#pin-markings- and here are some rough draft instructions: https://community.particle.io/t/electron-power-leak-from-vbat/21312/5
  • Electron Charging LED: But what is the "appropriate firmware command"? #326
  • Change Vin and Iin parameters to Vvin and Ivin to be more clear
  • EEPROM emulation bank 2 (64 KB) - remove only 16k used
  • v002 of the Pinout PDF has an error in the lower left of the Legend, UART4 and UART5 should be Serial4 and Serial5, not Serial2 and Serial3.
  • CAN bus pins should be noted as 3.3V tolerant (technically they are 5V tolerant on the RX but since you wouldn't operate them with a 5V transceiver it's proper to classify them as 3.3V)
  • Memory Map: for v0.6.0-rc.1 and later has 3 system parts and re-ordering (1,2,3 is now 2,1,3).
  • update DCD Layout https://docs.particle.io/datasheets/electron-datasheet/#dcd-layout notably adding radio_flags, and any other new sections.

P1 Datasheet (v007)

Electron Datasheet (v004)

  • Replace some copy/paste errors in STM32 part number in Electron datasheet copied from Photon datasheet. Replace all STM32F205RGY6 with STM32F205RGT6.
  • Add full STM32F205RGT6 part number to every mention of STM32 in datasheet.

Photon Datasheet (v014)

  • Updated list of Mating Connectors

Electron Datasheet (v003)

  • Fix and clarify pin descriptions #399 (make sure to review P1 and Photon datasheets as well)
  • ERROR in Operating Current (Cellular OFF) IINavg 2-15mA, it should be IINavg 47-50mA
  • Updated list of Mating Connectors

P1 Datasheet (v006)

  • Update P1 pin listing: TESTMODE pin 33 (PA8), connected to MCO1 by default, outputs 32kHz clock for WICED powersave mode - currently unsupported for user control.

Electron Datasheet (v002)

  • Add size of Electron SIM card Nano (4FF) to all places in where SIM is referenced in the datasheet. Also include a link to a comparison of sizes.
  • Add memory map to datasheet, high level DCD view with link to the API for DCD: (use #82 as reference as well)
  • Add explanation of power inputs/outputs (PMIC/USB/VIN/Li+/3V3/3V8), and add this warning: It is not recommended to feed the Electron's 3V3 node with an external 3.3V source. Only use this 3V3 pin as an output for supporting circuitry.
  • Add DAC output limits: min resistive load is 5k ohms, and max capacitive load is 50pF.
  • SWD pin locations
  • Pinout diagram could use clarification, see #310
  • Rework block diagram to remove the dot-junction for VUSB and STM32F205, they are not connected. Only the two data lines are connected. https://docs.particle.io/datasheets/electron-datasheet/#block-diagram
  • Clean-up Recommended Operating Conditions Table #325

Photon Datasheet (v013)

  • Update Block Diagram to show VBAT broken out separately from the 3.3V supply https://docs.particle.io/datasheets/photon-datasheet/#block-diagram
  • Add full STM32F205RGY6 part number to the datasheet.
  • Change Vin and Iin parameters to Vvin and Ivin to be more clear
  • Update BT COEX section with link to example of how to control as GPIO, or add a note as note supported.Remove reference to using BT COEX pins as GPIO, this is not currently practical.
  • Add memory map to datasheet, high level DCD view with link to the API for DCD: #82
  • Add max source/sink current for I/Os, and total (each I/O is 25mA and total is 120mA)
  • Add SWD mode hookups to the JTAG info: https://community.particle.io/t/connections-for-st-link-v2-mini-jtag/16659
  • "Typical current consumption is 80mA with a 3.3V input. Deep sleep quiescent current is 160uA. " OLD INFO (SEE recommended operating conditions instead)
  • Add a section for test points, and point out where in the datasheet they are referenced. #223
  • Add known errata link that points back to this issue, which will be updated in the future with new issues found in the datasheet.
  • Add DAC output limits: min resistive load is 5k ohms, and max capacitive load is 50pF.
  • clarified note about routing signals under the Photon's antenna

P1 Datasheet (v005)

  • Pinout image 3, RESET button pin is 34 (MICRO_RST_N), not 26.
  • Add full STM32F205RGY6 part number to the datasheet.
  • Update BT COEX section with link to example of how to control as GPIO, or add a note as note supported.Remove reference to using BT COEX pins as GPIO, this is not currently practical.
  • Add memory map to datasheet, high level DCT view with link to the API for DCT: #82
  • Add max source/sink current for I/Os, and total (each I/O is 25mA and total is 120mA)
  • Add SWD mode hookups to the JTAG info: https://community.particle.io/t/connections-for-st-link-v2-mini-jtag/16659
  • Add note about 5V @ VIN for P1, this is in reference to when the SMPS shown in the Reference Design is implemented and current is measured from the VIN node shown on the schematic: https://docs.particle.io/datasheets/p1-datasheet/#recommended-operating-conditions-i-class-icon-check-i-
  • "Typical current consumption is 80mA with a 3.3V input. Deep sleep quiescent current is 160uA. " OLD INFO (SEE recommended operating conditions instead)
  • Add known errata link that points back to this issue, which will be updated in the future with new issues found in the datasheet.
  • Change all references to "Spare1-6" to "P1S0" - "P1S5"
  • Add dimension info for TAPE: https://docs.particle.io/datasheets/-datasheet/#tape-and-reel-info
  • Add DAC output limits: min resistive load is 5k ohms, and max capacitive load is 50pF.
  • clarified note about routing signals under the P1's antenna

Photon Datasheet (v012)

  • Added some information for TELEC certification stuff

Photon Datasheet (v011)

  • Add FCC IC CE Warnings and End Product Labeling Requirements, Update power output
  • Minor fix to section 3.2: A0A9 should be A0A7. Description is correct.
  • Section 3.2: Mention of A5 should be A3. Also call out DAC1 as A6. Can also be used as A3, and A6 in software.
  • Add extra pin numbers to the land pattern (25 - 31) and ref. to section 3 of the datasheet.
  • Fix RGB led part number on BOM: https://community.particle.io/t/photon-rgb-led-bom-and-footprint-dont-match/12973

Photon Datasheet (v010)

  • Update VBAT info.

Photon Datasheet (v009)

  • Remove RX and TX as ADCs.
  • Add DAC as an ADC channel 4 to the pinout diagrams and text.
  • DAC1 and DAC2 are both 12-bit, not 10-bit.
  • Fix height dimensions:
    Should be:
    With 1.44 x 0.8 x 0.27 (36.58 x 20.32 x 6.86) 5 grams
    Without 1.44 x 0.8 x 0.17 (36.58 x 20.32 x 4.32) 3.7 grams
  • Update quiescent current (80uA typical, 100uA max)

Photon Datasheet (v008)

  • Replace "Spark" with "Particle"
  • Add lead-free logo
  • Add Ordering information section (just points to store)
  • Add FCC ID, IC ID and FCC and CE logos
  • Replace the packaging image with a better quality one

PØ Datasheet (v002) - Not Released Yet

  • Image of PØ with pin numbers
  • Image of PØ with dimensions
  • Image of PØ module dimensions
  • Image of PØ module land pattern (and solder mask size)
  • Image of PØ Tape with Dimensions, Orientation and Feed Direction
  • Images of Reference Design Schematic
  • Images of Reference Design PCB
  • Image of colorful pinouts (use Photon's)
  • Image of Power Connections
  • Image of PØ module (vector) for cover page.
  • Image of PØ Block Diagram
  • Replace "Spark" with "Particle"
  • Change github.com/spark to github.com/particleio
  • Change Spark.lbr to Particle.lbr
  • Text for all sections

P1 Datasheet (v004)

  • Pin number 54 is used twice in pin mapping table. A0 / GPIO14 is pin 50 and not 54
  • Fold in any corrections made to Photon Datasheet.
  • Evaluation of this report:
  • JTAG: The schematic shows the Photon instead of the P1. Also, I was wondering if I need to breakout the Broadcom JTAG pins as well.
  • 2.6 External Coexistence Interface: I guess this text is from the Photon. I don't have a P1 in-hand yet so I can only guess based on pictures but aren't the coexistence signals routed to regular pads on the bottom of the module, unlike yours on the Photon? Accordingly, the table should show the P1 pin numbers as 57, 56, 58.
  • 3.2 Pin Description (DAC): I think DAC2 is A3 instead of A5.

P1 Datasheet (v003)

  • Update VBAT_MICRO info

P1 Datasheet (v002)

  • Image of P1 with pin numbers
  • Image of P1 with dimensions
  • Image of P1 module dimensions
  • Image of P1 module land pattern (and solder mask size)
  • Image of P1 Tape with Dimensions, Orientation and Feed Direction
  • Images of Reference Design Schematic
  • Image of colorful pinouts (use Photon's, add extra pins)
  • Image of Power Connections
  • Image of P1 module (vector) for cover page.
  • Replace "Spark" with "Particle"
  • Text for all sections

Community Updates

Update these threads when P1, PØ datasheets are released.

Photon Tinker Page

  • Add documentation on the new Tinker App
  • Replace screenshots with shots from the new Tinker app
  • Make any necessary changes to the Core Tinker page

Self-scrolling/persistent nav-bar

As the firmware page grows, looking at content way below requires a user to scroll back wayyyyy up in order to navigate through other sections.

Would be great if the nav-bar if the left stays while content on the right scrolls!

@wgbartley

Photon Hardware

  • Add Photon datasheet as PDF to Hardware page
  • Add Photon datasheet as Markdown to Hardware page

Documentation for disabling preprocessor

Notes:

The preprocessor sometimes needs to be disabled with

#pragma SPARK_NO_PREPROCESSOR

at the top of the file in order for valid code to compile successfully,
but there's currently no published docs for this.

FYI, this is only necessary for .INO files compiled with Spark IDE, Spark CLI or Spark Dev

Code tweaks to docs

  • Fix tables on mobile screens
  • Fix spacing on sub-menus
  • Cleanup nav bar to change GH link/edits
  • Re-route edit button to still link to new structure
  • Add support link to the nav bar on docs

CLI Page

  • Make any changes to the code samples if we change our npm package name or any command name changes in the CLI
  • Add any photon-specific changes to the CLI

Photon Examples

  • Create new Fritzing diagrams for each example on the Photon Examples page with the Photon device in the diagram
  • Document any new photon-specific examples on the Photon Examples page

docs.particle.io/firmware 404's

Would be nicer if URLs of that format redirected to /photon/firmware at minimum, and even more ideally to /core/firmware or /photon/firmware based on the user's previous choice.

Update CLI command

  • remove cloud claim It doesn't even exists anymore
  • add all the current commands
  • change claim to add

Photon Changes

  • Getting Started: Photon setup process
  • Getting Started: "Wait what is this thing" equivalent-- photon desc
  • Connecting Your Device:Soft AP Set up with Particle App for Photon
  • Document 5V tolerant pins: particle-iot/photon#7

Updates for V0.4.0 firmware

  • [getPinMode(pin)] #261 (tested with bugs)
  • [Serial Y modem?] #215 (tested with SOS flash)
  • [WiFi.resolve()]
  • [WiFi.selectAntenna()]
  • Photon memory map,both main memory and DCT area (dfu alt 1)
  • LED change callback
  • [shortened Spark.publish()] #285
  • [Rename to System.] Spark.sleep() and Spark.deviceID()
  • [update to use long seconds for System.sleep()]
  • Close Spark.process() discussion] #242
  • Change System.bootloader() to System.dfu()
  • Update WiFi.macAddress(mac) example:
for (int i=0; i<6; i++) {
        if (i) Serial.print(":");
        Serial.print(mac[i], HEX);
      }

Actual pictures and videos to take

  • In box photon birds eye
  • In box core birds eye
  • Photon plugged in birds eye
  • Core plugged in birds eye
  • <10 sec video of Core in...
    • listening mode
    • trying to connect, then connected
    • connected
    • flashing
    • dfu
    • factory reset
    • any other modes...
  • <10 sec video of Photon in...
    • listening mode
    • trying to connect, then connected
    • connected
    • flashing
    • safe mode (magenta)
    • dfu (yellow)
    • replace firmware with factory reset but don't clear wifi
    • factory reset
    • any other modes...
  • Birds eye picture of core alone top and botton
  • Birds eye picture of Photon top (and bottom for completeness)
  • Core in breadboard wired for LED
  • Photon in breadboard wired for LED
  • Core in breadboard wired for temp
  • Photon in breadboard wired for temp
  • <10 sec video of Core of connecting with tinker
  • <10 sec video of Core of blinking LED with tinker
  • <10 sec video of Photon of connecting with tinker
  • <10 sec video of Photon of blinking LED with tinker

Should firmware headings follow syntax?

Looking at WIFI.CLEARCREDENTIALS() and WIFI.HASCREDENTIALS() that does not have a syntax example on the right, it takes a while and a more experienced person to figure out the syntax.

I will be sending in a PR to add the syntax example but this might be the way to go.

Thoughts? @technobly @cmsunu28 @spark/spark-elite-read-write

Blink LED over the internet example

Hey @cmsunu28 ,

While I was annotating the firmware examples so they could be imported into the web IDE programmatically, i noticed that the last firmware example uses D0 and D1 for LED pins. I was thinking it might be better if it used D7 for one of the pins so that the example would show something visible even without doing any wiring.

Assets To Update

Assets for Getting Started Requested by Christine

  • photo of available devices in packaging, partially unboxed (can see all the things that come in it)
  • updated asset of core, photon, plugged in and blinking blue
  • Core plugged into USB
  • Photon plugged into USB
  • updated screenshot of spark core app (which I assume will be renamed)
  • animations or illustrations for Getting to Know Your Core

Assets for Examples Requested by Christine

  • Updated Core and Photon photo for first Blink an LED image
  • Updated Fritzing diagrams for Core and Photon for Blink an LED
  • Updated Fritzing diagrams for Core and Photon for Control LEDs
  • Updated Fritzing diagrams for Core and Photon for Measuring Temperature
  • Vine video or animation of the LED blinking on a breadboard wired up with the Blink an LED example

Assets for Javascript SDK Requested by Christine

  • updated "login to spark" button

Assets for Webhooks Requested by Christine

  • webhooks librato cli example

Particle Dev Requested by Kevin

  • Pictures for spark dev now being particle dev in the introduction of the Particle Dev category

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.