mirror of
https://github.com/inventree/InvenTree.git
synced 2025-06-23 15:20:55 +00:00
11ab0203b1
* Add builtin plugin for auto-issuing orders * Add plugin to auto-issue orders * Add placeholder documentation * Fix typo * Adds image macro - To replace img.html - includes checking if file exists * Fix tooltips * More docs * Adjust plugin settings filters * docs * More docs * More docs * Updates * Less restrictive URL checking * Refactor build order page * Fix typo * Allow 429 * Debug output * More debug * Construct assets dir * Cleanup * Update docs README * Refactoring more pages * Fix image link * Fix SSO settings * Add hook to check for missing settings - Ensure that all settings are documented! * Add missing user settings * Update docstring * Tweak SSO.md * Image updates * More updates * Tweaks * Exclude orders without a target_date * Fix for issuing build orders * Further refactoring * Fixes * Image refactoring * More refactoring * More refactoring * Refactor app images * Fix pathing issues * Suppress some openapidocs warnings in logs (much easier to debug docs build issues) * Fix image reference * Reduce error messages * Fix image links * Fix image links * Reduce docs log output * Ensure settings are loaded before displaying them * Fix for UI test * Fix unit test * Test tweaks
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
---
|
|
title: Locate Mixin
|
|
---
|
|
|
|
## LocateMixin
|
|
|
|
The `LocateMixin` class enables plugins to "locate" stock items (or stock locations) via an entirely custom method.
|
|
|
|
For example, a warehouse could be arranged with each individual 'parts bin' having an audio-visual indicator (e.g. RGB LED and buzzer). "Locating" a particular stock item causes the LED to flash and the buzzer to sound.
|
|
|
|
Another example might be a parts retrieval system, where "locating" a stock item causes the stock item to be "delivered" to the user via a conveyor.
|
|
|
|
The possibilities are endless!
|
|
|
|
### Web Integration
|
|
|
|
{{ image("plugin/web_locate.png", "Locate stock item from web interface", maxheight="400px") }}
|
|
|
|
### App Integration
|
|
|
|
If a locate plugin is installed and activated, the [InvenTree mobile app](../../app/index.md) displays a button for locating a StockItem or StockLocation (see below):
|
|
|
|
{{ image("plugin/app_locate.png", "Locate stock item from app", maxheight="400px") }}
|
|
|
|
### Implementation
|
|
|
|
Refer to the [InvenTree source code]({{ sourcefile("src/backend/InvenTree/plugin/samples/locate/locate_sample.py") }}) for a simple implementation example.
|
|
|
|
### Sample Plugin
|
|
|
|
A simple example is provided in the InvenTree code base:
|
|
|
|
::: plugin.samples.locate.locate_sample.SampleLocatePlugin
|
|
options:
|
|
show_bases: False
|
|
show_root_heading: False
|
|
show_root_toc_entry: False
|
|
show_source: True
|
|
members: []
|