Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 191 additions & 0 deletions lims_maintenance/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
===========================================================
Laboratory Information Management System (LIMS) Maintenance
===========================================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:70747ad32697f3e6b75eb41cd294ec7f59fb5a6f8bdf682d3c45d92e0e2ddd03
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fconnector--lims-lightgray.png?logo=github
:target: https://github.com/OCA/connector-lims/tree/18.0/lims_maintenance
:alt: OCA/connector-lims
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/connector-lims-18-0/connector-lims-18-0-lims_maintenance
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/connector-lims&target_branch=18.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module integrates the **LIMS (Laboratory Information Management
System)** with Odoo’s **Maintenance** application.

It allows each **LIMS Instrument** to be linked to a **Maintenance
Equipment** record, providing traceability and centralized management of
laboratory instruments and their maintenance schedules.

Key Features
~~~~~~~~~~~~

- Adds a field ``equipment_id`` on the ``lims.instrument`` model.
- Links each instrument with an equipment record from the Maintenance
module.
- Displays the associated Maintenance Equipment directly on the
instrument form.
- Enables maintenance tracking, scheduling, and reporting for laboratory
instruments.

**Table of contents**

.. contents::
:local:

Configuration
=============

Prerequisites
-------------

Ensure the following modules are installed and configured:

- **lims**
- **maintenance**

Both are required for this module to function properly.

--------------

Configuration Steps
-------------------

1. Go to **Maintenance → Equipment** and create or configure your lab
equipment.
2. Open **LIMS → Instruments**.
3. In the instrument form view, select the corresponding **Maintenance
Equipment** record from the new “Maintenance” section.
4. Save your changes.

--------------

Usage
=====

Once configured, you can link each **LIMS Instrument** to its
corresponding **Maintenance Equipment** record.

--------------

Linking Instruments to Maintenance Equipment
--------------------------------------------

1. Go to **LIMS → Instruments**.
2. Open any instrument record.
3. In the **Maintenance** section, choose a record from the *Maintenance
Equipment* dropdown.
4. Save the instrument record.

The instrument is now linked to the selected maintenance equipment.

--------------

Viewing Linked Equipment
------------------------

- Open the instrument form.
- The linked **Maintenance Equipment** appears in the *Maintenance*
section.
- You can click on the linked record to open the full Maintenance
Equipment form.

--------------

Example Workflow
----------------

1. The laboratory maintains several instruments (e.g., Spectrometer,
HPLC, pH Meter).
2. Each instrument exists in both **LIMS Instruments** and **Maintenance
Equipment**.
3. After installing ``lims_maintenance``, link each LIMS instrument to
its Maintenance Equipment.
4. Maintenance operations and scheduling are now traceable directly from
LIMS.

--------------

Unlinking
---------

To unlink an instrument from maintenance:

1. Edit the instrument record.
2. Clear the *Maintenance Equipment* field.
3. Save the record.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/connector-lims/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/connector-lims/issues/new?body=module:%20lims_maintenance%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Open Source Integrators

Contributors
------------

- Rodrigo Madrid rmadrid@opensourceintegrators.com
- Adriana Alpizar aalpizar@opensourceintegrators.com
- Maxime Chambreuil mchambreuil@opensourceintegrators.com
- Nikul Chaudhary nchaudhary@opensourceintegrators.com

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-max3903| image:: https://github.com/max3903.png?size=40px
:target: https://github.com/max3903
:alt: max3903
.. |maintainer-jasiel-osi| image:: https://github.com/jasiel-osi.png?size=40px
:target: https://github.com/jasiel-osi
:alt: jasiel-osi
.. |maintainer-Nikul-OSI| image:: https://github.com/Nikul-OSI.png?size=40px
:target: https://github.com/Nikul-OSI
:alt: Nikul-OSI

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-max3903| |maintainer-jasiel-osi| |maintainer-Nikul-OSI|

This module is part of the `OCA/connector-lims <https://github.com/OCA/connector-lims/tree/18.0/lims_maintenance>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions lims_maintenance/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Copyright (C) 2025 Open Source Integrators
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from . import models
18 changes: 18 additions & 0 deletions lims_maintenance/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Copyright (C) 2025 Open Source Integrators
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
{
"name": "Laboratory Information Management System (LIMS) Maintenance",
"summary": "Manage the maintenance of your LIMS instruments",
"version": "18.0.1.0.0",
"license": "AGPL-3",
"category": "Manufacturing/Maintenance",
"author": "Open Source Integrators, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/connector-lims",
"depends": ["lims", "maintenance"],
"data": [
"views/lims_instrument_views.xml",
],
"application": False,
"development_status": "Beta",
"maintainers": ["max3903", "jasiel-osi", "Nikul-OSI"],
}
3 changes: 3 additions & 0 deletions lims_maintenance/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Copyright (C) 2025 Open Source Integrators
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from . import lims_instrument
13 changes: 13 additions & 0 deletions lims_maintenance/models/lims_instrument.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright (C) 2025 Open Source Integrators
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo import fields, models


class LimsInstrument(models.Model):
_inherit = "lims.instrument"

equipment_id = fields.Many2one(
comodel_name="maintenance.equipment",
string="Maintenance Equipment",
help="Link this instrument to a Maintenance Equipment record.",
)
3 changes: 3 additions & 0 deletions lims_maintenance/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
17 changes: 17 additions & 0 deletions lims_maintenance/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Prerequisites
Ensure the following modules are installed and configured:
- **lims**
- **maintenance**

Both are required for this module to function properly.

---

## Configuration Steps

1. Go to **Maintenance → Equipment** and create or configure your lab equipment.
2. Open **LIMS → Instruments**.
3. In the instrument form view, select the corresponding **Maintenance Equipment** record from the new “Maintenance” section.
4. Save your changes.

---
4 changes: 4 additions & 0 deletions lims_maintenance/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* Rodrigo Madrid <rmadrid@opensourceintegrators.com>
* Adriana Alpizar <aalpizar@opensourceintegrators.com>
* Maxime Chambreuil <mchambreuil@opensourceintegrators.com>
* Nikul Chaudhary <nchaudhary@opensourceintegrators.com>
9 changes: 9 additions & 0 deletions lims_maintenance/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
This module integrates the **LIMS (Laboratory Information Management System)** with Odoo’s **Maintenance** application.

It allows each **LIMS Instrument** to be linked to a **Maintenance Equipment** record, providing traceability and centralized management of laboratory instruments and their maintenance schedules.

### Key Features
- Adds a field `equipment_id` on the `lims.instrument` model.
- Links each instrument with an equipment record from the Maintenance module.
- Displays the associated Maintenance Equipment directly on the instrument form.
- Enables maintenance tracking, scheduling, and reporting for laboratory instruments.
37 changes: 37 additions & 0 deletions lims_maintenance/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Once configured, you can link each **LIMS Instrument** to its corresponding **Maintenance Equipment** record.

---

## Linking Instruments to Maintenance Equipment

1. Go to **LIMS → Instruments**.
2. Open any instrument record.
3. In the **Maintenance** section, choose a record from the *Maintenance Equipment* dropdown.
4. Save the instrument record.

The instrument is now linked to the selected maintenance equipment.

---

## Viewing Linked Equipment

- Open the instrument form.
- The linked **Maintenance Equipment** appears in the *Maintenance* section.
- You can click on the linked record to open the full Maintenance Equipment form.

---

## Example Workflow

1. The laboratory maintains several instruments (e.g., Spectrometer, HPLC, pH Meter).
2. Each instrument exists in both **LIMS Instruments** and **Maintenance Equipment**.
3. After installing `lims_maintenance`, link each LIMS instrument to its Maintenance Equipment.
4. Maintenance operations and scheduling are now traceable directly from LIMS.

---

## Unlinking
To unlink an instrument from maintenance:
1. Edit the instrument record.
2. Clear the *Maintenance Equipment* field.
3. Save the record.
Loading
Loading