netbox-plugin-sonance-amp 0.9.3__tar.gz

netbox_plugin_sonance_amp-0.9.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stefan Bethke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netbox_plugin_sonance_amp-0.9.3/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: netbox-plugin-sonance-amp
+Version: 0.9.3
+Summary: NetBox plugin modeling Sonance SonAmp input and output parameters on interfaces
+Author-email: Stefan Bethke <stb@lassitu.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/stblassitude/netbox-plugin-sonance-amp
+Project-URL: Issues, https://github.com/stblassitude/netbox-plugin-sonance-amp/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Netbox Plugin for Sonance Amp Input and Output Parameters
+
+This plugin models SonAmp input and output parameters as an extension to an "Other" Interface.
+
+## Data Model
+
+Configuration parameters for inputs and outputs are stored in two models: AmpInputSettings and AmpOutputSettings, which are tied to an Interface through a one-to-one foreign key relationship.
+
+For AmpInputSettings, the following fields are managed:
+* Level Trim dB: value of -6.0 to 6.0 in 0.5 steps
+
+The Interface Label field is applied to the Input Name parameter.
+
+For AmpOutputSettings, the following fields are managed:
+* Output Setup 
+    * Stereo/Mono: "stereo" or "mono"
+    * DSP Preset: preset name (freeform string)
+    * Output Group: choice of "A" to "H"
+    * Bridge Mode: "on" or "off"
+* Output Source
+    * Output Source 1: choice of "1L", "1R", ... to "4R"
+    * Output Source 2: as above
+    * Mode Source 2: choice of "mute", "mix", or "off"
+* Output Volume
+    * Output Volume: value between -70 and 12
+    * Turn On Volume: as above
+    * Maximum Volume: as above
+    * Gain Offset: value of -6.0 to 6.0 in 0.5 steps
+    * Mute: "on" or "off"
+
+The Interface Label field is applied to the Output Name parameter.
+
+## User Interface
+
+The plugin ties the custom model editing into the Interface detail form. The editing form allows choosing "No amp parameters", "Input amp parameters", or "Output amp parameters" for each interface. Changing the type will add or remove the respective model entry, and show the correct form for the type.
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|-----------------|----------------|
+| 4.1 - 4.99      | 0.1.0          |
+
+## Installation
+
+Install the plugin into your NetBox virtual environment:
+
+```bash
+pip install netbox-plugin-sonance-amp
+```
+
+Enable it in your NetBox `configuration.py` (or `plugins.py`, if using [netbox-docker](https://github.com/netbox-community/netbox-docker)):
+
+```python
+PLUGINS = [
+    "netbox_plugin_sonance_amp",
+]
+```
+
+Then run migrations and restart NetBox:
+
+```bash
+python manage.py migrate
+python manage.py collectstatic --no-input
+```
+
+## Development / Testing
+
+A self-contained Docker Compose setup is included for trying the plugin out against a real NetBox instance. It builds a NetBox image with the plugin installed from this repository's source, so no packaging or PyPI publish is required.
+
+```bash
+docker compose up -d --build
+```
+
+Once the `netbox` service reports healthy, log in at <http://localhost:8000/> with `admin` / `admin`. A demo device, `sonamp-1`, is created automatically with an `Input 1` and an `Output 1` interface (both type "Other") so you can open either interface's detail page and add amp parameters right away.
+
+To stop and remove the stack (including its database volume):
+
+```bash
+docker compose down -v
+```
+

netbox_plugin_sonance_amp-0.9.3/README.md

@@ -0,0 +1,81 @@
+# Netbox Plugin for Sonance Amp Input and Output Parameters
+
+This plugin models SonAmp input and output parameters as an extension to an "Other" Interface.
+
+## Data Model
+
+Configuration parameters for inputs and outputs are stored in two models: AmpInputSettings and AmpOutputSettings, which are tied to an Interface through a one-to-one foreign key relationship.
+
+For AmpInputSettings, the following fields are managed:
+* Level Trim dB: value of -6.0 to 6.0 in 0.5 steps
+
+The Interface Label field is applied to the Input Name parameter.
+
+For AmpOutputSettings, the following fields are managed:
+* Output Setup 
+    * Stereo/Mono: "stereo" or "mono"
+    * DSP Preset: preset name (freeform string)
+    * Output Group: choice of "A" to "H"
+    * Bridge Mode: "on" or "off"
+* Output Source
+    * Output Source 1: choice of "1L", "1R", ... to "4R"
+    * Output Source 2: as above
+    * Mode Source 2: choice of "mute", "mix", or "off"
+* Output Volume
+    * Output Volume: value between -70 and 12
+    * Turn On Volume: as above
+    * Maximum Volume: as above
+    * Gain Offset: value of -6.0 to 6.0 in 0.5 steps
+    * Mute: "on" or "off"
+
+The Interface Label field is applied to the Output Name parameter.
+
+## User Interface
+
+The plugin ties the custom model editing into the Interface detail form. The editing form allows choosing "No amp parameters", "Input amp parameters", or "Output amp parameters" for each interface. Changing the type will add or remove the respective model entry, and show the correct form for the type.
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|-----------------|----------------|
+| 4.1 - 4.99      | 0.1.0          |
+
+## Installation
+
+Install the plugin into your NetBox virtual environment:
+
+```bash
+pip install netbox-plugin-sonance-amp
+```
+
+Enable it in your NetBox `configuration.py` (or `plugins.py`, if using [netbox-docker](https://github.com/netbox-community/netbox-docker)):
+
+```python
+PLUGINS = [
+    "netbox_plugin_sonance_amp",
+]
+```
+
+Then run migrations and restart NetBox:
+
+```bash
+python manage.py migrate
+python manage.py collectstatic --no-input
+```
+
+## Development / Testing
+
+A self-contained Docker Compose setup is included for trying the plugin out against a real NetBox instance. It builds a NetBox image with the plugin installed from this repository's source, so no packaging or PyPI publish is required.
+
+```bash
+docker compose up -d --build
+```
+
+Once the `netbox` service reports healthy, log in at <http://localhost:8000/> with `admin` / `admin`. A demo device, `sonamp-1`, is created automatically with an `Input 1` and an `Output 1` interface (both type "Other") so you can open either interface's detail page and add amp parameters right away.
+
+To stop and remove the stack (including its database volume):
+
+```bash
+docker compose down -v
+```
+

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/__init__.py

@@ -0,0 +1,17 @@
+from netbox.plugins import PluginConfig
+
+
+class SonanceAmpConfig(PluginConfig):
+    name = 'netbox_plugin_sonance_amp'
+    verbose_name = 'Sonance Amp'
+    description = 'Model Sonance SonAmp input and output parameters on NetBox interfaces'
+    version = '0.1.0'
+    author = 'Stefan Bethke'
+    author_email = 'stb@lassitu.de'
+    base_url = 'sonance-amp'
+    min_version = '4.1.0'
+    max_version = '4.99.99'
+    default_settings = {}
+
+
+config = SonanceAmpConfig

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/admin.py

@@ -0,0 +1,15 @@
+from django.contrib import admin
+
+from .models import AmpInputSettings, AmpOutputSettings
+
+
+@admin.register(AmpInputSettings)
+class AmpInputSettingsAdmin(admin.ModelAdmin):
+    list_display = ('interface', 'level_trim_db')
+
+
+@admin.register(AmpOutputSettings)
+class AmpOutputSettingsAdmin(admin.ModelAdmin):
+    list_display = (
+        'interface', 'stereo_mono', 'dsp_preset', 'output_group', 'bridge_mode', 'output_volume', 'mute',
+    )

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/api/serializers.py

@@ -0,0 +1,36 @@
+from dcim.api.serializers import InterfaceSerializer
+from netbox.api.fields import ChoiceField
+from netbox.api.serializers import NetBoxModelSerializer
+
+from ..choices import ModeSource2Choices, OutputGroupChoices, OutputSourceChoices, StereoModeChoices
+from ..models import AmpInputSettings, AmpOutputSettings
+
+
+class AmpInputSettingsSerializer(NetBoxModelSerializer):
+    interface = InterfaceSerializer(nested=True)
+
+    class Meta:
+        model = AmpInputSettings
+        fields = (
+            'id', 'url', 'display', 'interface', 'level_trim_db', 'tags', 'custom_fields', 'created',
+            'last_updated',
+        )
+        brief_fields = ('id', 'url', 'display', 'interface', 'level_trim_db')
+
+
+class AmpOutputSettingsSerializer(NetBoxModelSerializer):
+    interface = InterfaceSerializer(nested=True)
+    stereo_mono = ChoiceField(choices=StereoModeChoices)
+    output_group = ChoiceField(choices=OutputGroupChoices, required=False)
+    output_source_1 = ChoiceField(choices=OutputSourceChoices, required=False)
+    output_source_2 = ChoiceField(choices=OutputSourceChoices, required=False)
+    mode_source_2 = ChoiceField(choices=ModeSource2Choices, required=False)
+
+    class Meta:
+        model = AmpOutputSettings
+        fields = (
+            'id', 'url', 'display', 'interface', 'stereo_mono', 'dsp_preset', 'output_group', 'bridge_mode',
+            'output_source_1', 'output_source_2', 'mode_source_2', 'output_volume', 'turn_on_volume',
+            'maximum_volume', 'gain_offset', 'mute', 'tags', 'custom_fields', 'created', 'last_updated',
+        )
+        brief_fields = ('id', 'url', 'display', 'interface', 'stereo_mono', 'dsp_preset')

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/api/urls.py

@@ -0,0 +1,11 @@
+from netbox.api.routers import NetBoxRouter
+
+from . import views
+
+app_name = 'netbox_plugin_sonance_amp'
+
+router = NetBoxRouter()
+router.register('input-settings', views.AmpInputSettingsViewSet)
+router.register('output-settings', views.AmpOutputSettingsViewSet)
+
+urlpatterns = router.urls

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/api/views.py

@@ -0,0 +1,17 @@
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from ..filtersets import AmpInputSettingsFilterSet, AmpOutputSettingsFilterSet
+from ..models import AmpInputSettings, AmpOutputSettings
+from .serializers import AmpInputSettingsSerializer, AmpOutputSettingsSerializer
+
+
+class AmpInputSettingsViewSet(NetBoxModelViewSet):
+    queryset = AmpInputSettings.objects.prefetch_related('interface', 'tags')
+    serializer_class = AmpInputSettingsSerializer
+    filterset_class = AmpInputSettingsFilterSet
+
+
+class AmpOutputSettingsViewSet(NetBoxModelViewSet):
+    queryset = AmpOutputSettings.objects.prefetch_related('interface', 'tags')
+    serializer_class = AmpOutputSettingsSerializer
+    filterset_class = AmpOutputSettingsFilterSet

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/choices.py

@@ -0,0 +1,50 @@
+from utilities.choices import ChoiceSet
+
+
+class AmpParameterTypeChoices(ChoiceSet):
+    """
+    Which amp parameter set, if any, is attached to a given interface.
+    """
+    NONE = 'none'
+    INPUT = 'input'
+    OUTPUT = 'output'
+
+    CHOICES = [
+        (NONE, 'No amp parameters', 'gray'),
+        (INPUT, 'Input amp parameters', 'blue'),
+        (OUTPUT, 'Output amp parameters', 'green'),
+    ]
+
+
+class StereoModeChoices(ChoiceSet):
+    STEREO = 'stereo'
+    MONO = 'mono'
+
+    CHOICES = [
+        (STEREO, 'Stereo', 'blue'),
+        (MONO, 'Mono', 'purple'),
+    ]
+
+
+class OutputGroupChoices(ChoiceSet):
+    CHOICES = [(letter, letter) for letter in 'ABCDEFGH']
+
+
+class OutputSourceChoices(ChoiceSet):
+    CHOICES = [
+        (f'{number}{channel}', f'{number}{channel}')
+        for number in range(1, 5)
+        for channel in ('L', 'R')
+    ]
+
+
+class ModeSource2Choices(ChoiceSet):
+    MUTE = 'mute'
+    MIX = 'mix'
+    OFF = 'off'
+
+    CHOICES = [
+        (MUTE, 'Mute', 'red'),
+        (MIX, 'Mix', 'blue'),
+        (OFF, 'Off', 'gray'),
+    ]

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/filtersets.py

@@ -0,0 +1,38 @@
+from django.db.models import Q
+
+from netbox.filtersets import NetBoxModelFilterSet
+
+from .models import AmpInputSettings, AmpOutputSettings
+
+
+class AmpInputSettingsFilterSet(NetBoxModelFilterSet):
+
+    class Meta:
+        model = AmpInputSettings
+        fields = ('id', 'interface', 'level_trim_db')
+
+    def search(self, queryset, name, value):
+        if not value.strip():
+            return queryset
+        return queryset.filter(
+            Q(interface__name__icontains=value) |
+            Q(interface__device__name__icontains=value)
+        )
+
+
+class AmpOutputSettingsFilterSet(NetBoxModelFilterSet):
+
+    class Meta:
+        model = AmpOutputSettings
+        fields = (
+            'id', 'interface', 'stereo_mono', 'dsp_preset', 'output_group', 'bridge_mode', 'mode_source_2', 'mute',
+        )
+
+    def search(self, queryset, name, value):
+        if not value.strip():
+            return queryset
+        return queryset.filter(
+            Q(interface__name__icontains=value) |
+            Q(interface__device__name__icontains=value) |
+            Q(output_group__icontains=value)
+        )

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/forms.py

@@ -0,0 +1,89 @@
+from django import forms
+
+from dcim.models import Interface
+from netbox.forms import NetBoxModelForm
+from utilities.forms.fields import DynamicModelChoiceField
+from utilities.forms.rendering import FieldSet
+
+from .choices import (
+    AmpParameterTypeChoices, ModeSource2Choices, OutputGroupChoices, OutputSourceChoices, StereoModeChoices,
+)
+from .models import AmpInputSettings, AmpOutputSettings
+
+
+class AmpInputSettingsForm(NetBoxModelForm):
+    interface = DynamicModelChoiceField(
+        queryset=Interface.objects.all(),
+    )
+
+    fieldsets = (
+        FieldSet('interface', 'level_trim_db', name='Input Settings'),
+    )
+
+    class Meta:
+        model = AmpInputSettings
+        fields = ('interface', 'level_trim_db', 'tags')
+
+
+class AmpOutputSettingsForm(NetBoxModelForm):
+    interface = DynamicModelChoiceField(
+        queryset=Interface.objects.all(),
+    )
+
+    fieldsets = (
+        FieldSet('interface', name='Interface'),
+        FieldSet('stereo_mono', 'dsp_preset', 'output_group', 'bridge_mode', name='Output Setup'),
+        FieldSet('output_source_1', 'output_source_2', 'mode_source_2', name='Output Source'),
+        FieldSet('output_volume', 'turn_on_volume', 'maximum_volume', 'gain_offset', 'mute', name='Output Volume'),
+    )
+
+    class Meta:
+        model = AmpOutputSettings
+        fields = (
+            'interface', 'stereo_mono', 'dsp_preset', 'output_group', 'bridge_mode',
+            'output_source_1', 'output_source_2', 'mode_source_2',
+            'output_volume', 'turn_on_volume', 'maximum_volume', 'gain_offset', 'mute', 'tags',
+        )
+        widgets = {
+            'gain_offset': forms.NumberInput(attrs={'step': '0.5'}),
+        }
+
+
+class AmpParameterForm(forms.Form):
+    """
+    Combined form used from an Interface's detail page to choose whether it carries no amp
+    parameters, input amp parameters, or output amp parameters, and to edit whichever
+    parameter set applies.
+    """
+    parameter_type = forms.ChoiceField(
+        label='Amp parameters',
+        choices=AmpParameterTypeChoices,
+    )
+
+    # AmpInputSettings fields
+    level_trim_db = forms.DecimalField(
+        label='Level trim (dB)', max_digits=4, decimal_places=1, min_value=-18, max_value=18, required=False,
+    )
+
+    # AmpOutputSettings fields
+    stereo_mono = forms.ChoiceField(choices=StereoModeChoices, required=False)
+    dsp_preset = forms.CharField(max_length=100, required=False)
+    output_group = forms.ChoiceField(choices=OutputGroupChoices, required=False)
+    bridge_mode = forms.BooleanField(required=False)
+    output_source_1 = forms.ChoiceField(choices=OutputSourceChoices, required=False)
+    output_source_2 = forms.ChoiceField(choices=OutputSourceChoices, required=False)
+    mode_source_2 = forms.ChoiceField(choices=ModeSource2Choices, required=False)
+    output_volume = forms.DecimalField(
+        max_digits=4, decimal_places=1, min_value=-70, max_value=12, required=False,
+    )
+    turn_on_volume = forms.DecimalField(
+        max_digits=4, decimal_places=1, min_value=-70, max_value=12, required=False,
+    )
+    maximum_volume = forms.DecimalField(
+        max_digits=4, decimal_places=1, min_value=-70, max_value=12, required=False,
+    )
+    gain_offset = forms.DecimalField(
+        max_digits=3, decimal_places=1, min_value=-6, max_value=6, required=False,
+        widget=forms.NumberInput(attrs={'step': '0.5'}),
+    )
+    mute = forms.BooleanField(required=False)

netbox_plugin_sonance_amp-0.9.3/netbox_plugin_sonance_amp/migrations/0001_initial.py

@@ -0,0 +1,68 @@
+# Generated by Django 6.1 on 2026-09-07 09:00
+
+import django.core.validators
+import django.db.models.deletion
+import netbox.models.deletion
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('dcim', '0250_cooling_infrastructure'),
+        ('extras', '0144_customfield_status'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='AmpInputSettings',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('level_trim_db', models.DecimalField(decimal_places=1, default=0, max_digits=4, validators=[django.core.validators.MinValueValidator(-18), django.core.validators.MaxValueValidator(18)])),
+                ('interface', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='sonance_amp_input_settings', to='dcim.interface')),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'verbose_name': 'amp input settings',
+                'verbose_name_plural': 'amp input settings',
+                'ordering': ('interface',),
+            },
+            bases=(netbox.models.deletion.DeleteMixin, models.Model),
+        ),
+        migrations.CreateModel(
+            name='AmpOutputSettings',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('stereo_mono', models.CharField(default='stereo', max_length=10)),
+                ('dsp_preset', models.CharField(blank=True, max_length=100)),
+                ('output_group', models.CharField(blank=True, max_length=1)),
+                ('bridge_mode', models.BooleanField(default=False)),
+                ('output_source_1', models.CharField(blank=True, max_length=2)),
+                ('output_source_2', models.CharField(blank=True, max_length=2)),
+                ('mode_source_2', models.CharField(blank=True, default='off', max_length=10)),
+                ('output_volume', models.DecimalField(decimal_places=1, default=0, max_digits=4, validators=[django.core.validators.MinValueValidator(-70), django.core.validators.MaxValueValidator(12)])),
+                ('turn_on_volume', models.DecimalField(decimal_places=1, default=-70, max_digits=4, validators=[django.core.validators.MinValueValidator(-70), django.core.validators.MaxValueValidator(12)])),
+                ('maximum_volume', models.DecimalField(decimal_places=1, default=12, max_digits=4, validators=[django.core.validators.MinValueValidator(-70), django.core.validators.MaxValueValidator(12)])),
+                ('gain_offset', models.DecimalField(decimal_places=1, default=0, max_digits=3, validators=[django.core.validators.MinValueValidator(-6), django.core.validators.MaxValueValidator(6)])),
+                ('mute', models.BooleanField(default=False)),
+                ('interface', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='sonance_amp_output_settings', to='dcim.interface')),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'verbose_name': 'amp output settings',
+                'verbose_name_plural': 'amp output settings',
+                'ordering': ('interface',),
+            },
+            bases=(netbox.models.deletion.DeleteMixin, models.Model),
+        ),
+    ]