diff --git a/README.md b/README.md index 89f6ca15778ff4702887a813ca55e285b9d9ea87..bc911434fca14c237a3e94145a118626531433bd 100644 --- a/README.md +++ b/README.md @@ -4,89 +4,45 @@ ## Getting started -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +Notes on Micropython for RP2040. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +Using xiao board. -## Add your files +Using PyCharm Micropython plugin. [Instructions here.](https://themachineshop.uk/getting-started-with-the-pi-pico-and-pycharm/) This works well. -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +[Quick reference for R2040 on Micropython site.](https://docs.micropython.org/en/latest/rp2/quickref.html#:~:text=RP2040%20has%20five%20ADC%20channels,range%20is%200%2D3.3V.) -``` -cd existing_repo -git remote add origin https://gitlab.cba.mit.edu/robhart/micropython-rp2040.git -git branch -M main -git push -uf origin main -``` +Nice examples for output, PWM, and ADC. -## Integrate with your tools +SPI in MicroPython for adxl343 [from Digikey](https://www.digikey.be/en/maker/projects/raspberry-pi-pico-rp2040-spi-example-with-micropython-and-cc/9706ea0cf3784ee98e35ff49188ee045) -- [ ] [Set up project integrations](https://gitlab.cba.mit.edu/robhart/micropython-rp2040/-/settings/integrations) +Pins on the adxl343 correspont to pins on the RP2040: +SCL = SCK P2, clock +SDA = MOSI P3, master TX +SDO = MISO P4, (Slave data out) Master RX +CS = Chip Select. P1 -## Collaborate with your team +This works, using alternate SPI0 pins. Note that for each of two hardware SPI, there are three pin configs. -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +For representation of acceleration, check [adxl343 datasheet](https://www.analog.com/media/en/technical-documentation/data-sheets/adxl343.pdf) -## Test and Deploy +According to the datasheet protocol, a read is done by + - CS low + - Send register address, with bit 7 high for read, bit 6 optionally high for multiple bytes. + - Read n bytes. + - CS high. (deassert). -Use the built-in continuous integration in GitLab. +In this program, data is read sequentially from six registers, using the SPI.read(n) function. The sequential register reading is described on p13 of the adxl343 datasheet. It requires setting the sixth bit of the register address high: "To read or write multiple bytes in a single transmission, the multiple-byte bit, located after the R/W bit in the first byte transfer +(MB in Figure 27 to Figure 29), must be set. After the register +addressing and the first byte of data, each subsequent set of clock +pulses (eight clock pulses) causes the ADXL343 to point to the next +register for a read or write. This shifting continues until the clock +pulses cease and CS is deasserted." -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +[For diagram of the sequential reading of registers to get the six bytes needed for x,y, and z:](https://www.analog.com/media/en/technical-documentation/application-notes/AN-1077.pdf) -*** +##23K256 memory chip as an example of SPI -# Editing this README +[Datasheet for 23K256:](https://ww1.microchip.com/downloads/en/DeviceDoc/22100F.pdf) -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +Set Polarity equal to zero for this chip. This is the level of the idle clock. See [SPI spec for MicroPython](https://docs.micropython.org/en/latest/library/machine.SPI.html)