docs: update tscircuit TI library guide for chip exports#764
docs: update tscircuit TI library guide for chip exports#764techmannih wants to merge 9 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
seveibar
left a comment
seveibar
left a comment
There was a problem hiding this comment.
it's more important right now to document CHIP usage, we can add subcircuit usage as we rename everything- "Subcircuit" doesn't make sense in ANY of these names. It needs to be e.g. "<VoltageRegulator_BQ24074 />" or whatever makes the most sense for the chip!!!
|
This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs. |
|
This PR was closed because it has been inactive for 1 day since being marked as stale. |
techmannih
changed the title
techmannih
changed the title
| title: Using the tscircuit TI Library | ||
| sidebar_position: 5 | ||
| description: Import Texas Instruments parts from the tscircuit TI library and connect to pins inside the imported subcircuit. | ||
| description: Import TI chip components from @tsci/tscircuit.ti and wire them like any other chip component. |
There was a problem hiding this comment.
the description line needs improvement, both the old one and the new one are pretty bad.
| description: Import TI chip components from @tsci/tscircuit.ti and wire them like any other chip component. | |
| description: Import ready-made Texas Instrument chips and functional subcircuit modules |
| you need them, such as `BQ24074RGTR` or `INA237AQDGSRQ1`. | ||
|
|
||
| The package root also includes higher-level reference circuits such as | ||
| `BatteryManagement_BQ24074`, but this guide focuses on chip-level usage. |
seveibar
left a comment
seveibar
left a comment
There was a problem hiding this comment.
this is really bad tbh- consider what the user needs to use the library, start with common user stories
| Then import a component from the package: | ||
| ## Import a TI Chip | ||
|
|
||
| For most cases, import the chip from the package root: |
There was a problem hiding this comment.
??? this phrasing is silly. Just tell the user what to do, wtf do you mean "For most cases....". Look at any library to see how its documented
| supplier part numbers, and pin labels from the TI library source. | ||
|
|
||
| If you need to target an exact package variant, you can also import the | ||
| manufacturer-part-number component directly from the same package root: |
There was a problem hiding this comment.
???? "manufacturer-part-number component" is not a concept that a user will understand!
|
|
||
| ## Preview a TI Part | ||
| The chip component already includes the manufacturer part number, footprint, | ||
| supplier part numbers, and pin labels from the TI library source. |
There was a problem hiding this comment.
uhh obviously? Why are you telling the user this? Useless information! This is a chip library of course it includes the required chip properties
| - `OUT` connects to a single external resistor using the selector | ||
| `.R_LOAD > .pin1`. | ||
| - `noConnect` marks the pins that are intentionally unused in this simplified | ||
| example. |
There was a problem hiding this comment.
why the explanation on how tscircuit works. Document the LIBRARY
|
|
||
| For more on chip props, see [Configuring Chips](../tscircuit-essentials/configuring-chips). | ||
| For more on selector syntax, see | ||
| [Port and Net Selectors](../tscircuit-essentials/port-and-net-selectors.md). |
There was a problem hiding this comment.
wtf!!!!!! THIS IS TI LIBRARY DOCUMENTATION don't tell the user how to use tscircuit
| - `.J1` selects the internal pinheader inside that subcircuit | ||
| - `.SCL` selects the `SCL` pin on that pinheader | ||
| It also exports exact manufacturer-part-number variants such as `BQ24074RGTR`, | ||
| `BQ25895RTWR`, and `INA237AQDGSRQ1` when you need a specific package option. |
| For more on selector syntax, see | ||
| [Port and Net Selectors](../tscircuit-essentials/port-and-net-selectors.md). | ||
|
|
||
| ## Finding More TI Chips |
There was a problem hiding this comment.
| ## Finding More TI Chips | |
| ## Available Chips |
2 participants
test https://docs-nwyurrmug-tscircuit.vercel.app/guides/importing-modules-and-chips/using-tscircuit-ti-library