Device Models Module Documentation

Module Overview (Technical)
Module Overview (Commercial/Business)
Module Overview (End User/Administrator)
Configuration Fields
Common Scenarios & Examples
Limitations & Important Notes
Troubleshooting Tips
Glossary

---

1. Module Overview (Technical)

What Are Device Models?

Device Models is a phone model catalog module that maintains specific phone models within the provisioning system. Models are linked to vendors and define hardware capabilities like DSS keys, expansion modules, and SIP lines.

Architecture

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Device Models Architecture                        │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Provisioning Hierarchy:                                        │
│                                                                 │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Vendors                                           │   │
│  │  ├─ Yealink                                             │   │
│  │  ├─ Grandstream                                         │   │
│  │  └─ Polycom                                             │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Device Models (this module)                            │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Device Models                                     │   │
│  │                                                          │   │
│  │  Yealink:                                               │   │
│  │  ├─ T54W (10 DSS keys, 2 exp modules, 16 lines)        │   │
│  │  ├─ T46U (27 DSS keys, 6 exp modules, 16 lines)        │   │
│  │  └─ T42S (6 DSS keys, 0 exp modules, 12 lines)         │   │
│  │                                                          │   │
│  │  Grandstream:                                           │   │
│  │  ├─ GXP2170 (48 DSS keys, 4 exp modules, 12 lines)     │   │
│  │  └─ GRP2612 (8 DSS keys, 0 exp modules, 4 lines)       │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Used by templates and devices                          │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Templates → Devices                               │   │
│  │                                                          │   │
│  │  Template selects model → Device inherits capabilities  │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

Table	Purpose
`public.provisioning_device_models`	Model definitions and capabilities

Key Files

File	Description
`modules/provisioningDeviceModels/`	Frontend module

---

2. Module Overview (Commercial/Business)

Business Value

Device Models provides hardware capability management:

Without Device Models	With Device Models
Unknown capabilities	Defined specs
Manual key counting	Auto DSS keys
No expansion info	Module support
Generic templates	Model-specific config

Use Cases

Capability Definition

- DSS key counts

- Expansion module support

Template Matching

- Model-specific templates

- Accurate key mapping

Device Inventory

- Track by model

- Report by type

Multi-model Support

- Different phone types

- Consistent provisioning

Feature Highlights

Feature	Benefit
DSS Keys	Line/BLF key count
Expansion Modules	Attachment support
SIP Lines	Account capacity
Vendor Linking	Organized catalog
MAC Prefix	Auto-detection
Image	Visual identification

---

3. Module Overview (End User/Administrator)

What Can You Do?

View all supported phone models
Add new device models
Define hardware capabilities
Set DSS key counts
Configure expansion module support
Associate with vendors
Upload model images

Device Models Interface

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Device Models                                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [+ Create Model]                                               │
│                                                                 │
│  [🔍 Search models...]                                          │
│                                                                 │
│  Filter by Vendor: [All ▼]                                      │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Model     │ Vendor      │ DSS │ Lines │ Exp │ Devices │   │  │
│  ├───────────┼─────────────┼─────┼───────┼─────┼─────────┤   │  │
│  │ T54W      │ Yealink     │ 10  │ 16    │ 2   │ 25      │ ✏️│  │
│  │ T46U      │ Yealink     │ 27  │ 16    │ 6   │ 12      │ ✏️│  │
│  │ T42S      │ Yealink     │ 6   │ 12    │ 0   │ 8       │ ✏️│  │
│  │ GXP2170   │ Grandstream │ 48  │ 12    │ 4   │ 15      │ ✏️│  │
│  │ GRP2612   │ Grandstream │ 8   │ 4     │ 0   │ 20      │ ✏️│  │
│  │ VVX450    │ Polycom     │ 30  │ 12    │ 3   │ 5       │ ✏️│  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Create/Edit Model

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Create Device Model                                │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Vendor: [Yealink ▼]                                           │
│                                                                 │
│  Model Name: [T54W                         ]                   │
│                                                                 │
│  Description: [Mid-range color IP phone    ]                   │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  Hardware Capabilities                                          │
│                                                                 │
│  DSS Keys: [10             ]                                   │
│    Number of programmable line/BLF keys                         │
│                                                                 │
│  SIP Lines: [16            ]                                   │
│    Maximum SIP account registrations                            │
│                                                                 │
│  Expansion Modules: [2     ]                                   │
│    Number of expansion module slots                             │
│                                                                 │
│  Keys per Module: [20      ]                                   │
│    DSS keys per expansion module                                │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  Identification                                                 │
│                                                                 │
│  MAC Prefix: [80:5E:C0     ]                                   │
│    For automatic vendor detection                               │
│                                                                 │
│  Model Image: [📤 Upload]                                       │
│                                                                 │
│  Status: [Active ▼]                                            │
│                                                                 │
│  [Save] [Cancel]                                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP

MAC Prefix: Used for auto-detection during network scanning.

TIP

Expansion Modules: Set to 0 if model doesn't support attachments.

NOTE

Pre-populated: Common models typically come pre-installed.

---

4. Configuration Fields

Basic Information

Field	Description
Vendor	Parent manufacturer
Model Name	Model identifier
Description	Model details
Status	Active/Inactive

Hardware Capabilities

Field	Description
DSS Keys	Programmable keys count
SIP Lines	Max SIP registrations
Expansion Modules	Attachment slots
Keys per Module	Keys per expansion

Identification

Field	Description
MAC Prefix	OUI for auto-detection
Model Image	Visual reference

---

5. Common Scenarios & Examples

Scenario 1: Browse Models

Navigate to Provisioning → Device Models
Filter by vendor (optional)
View hardware specs

Scenario 2: Add New Model

Click "Create Model"
Select vendor
Enter model name
Define DSS keys, lines, expansion
Add MAC prefix
Upload image (optional)
Save

Scenario 3: Update Capabilities

Find model in list
Click Edit
Update DSS keys or lines
Save

Scenario 4: Check Model Usage

View models list
Check "Devices" column
See how many devices use each model

---

6. Limitations & Important Notes

Technical Notes

NOTE

Vendor Required: Every model must belong to a vendor.

NOTE

Template Dependency: Models with templates cannot be deleted.

WARNING

DSS Key Accuracy: Incorrect counts affect template key mapping.

Best Practices

Verify Specs: Check manufacturer specs for accuracy
MAC Prefixes: Use correct OUI for auto-detection
Add Images: Visual identification helps users
Keep Updated: Add new models as released
Model Naming: Use official model names

Popular Models Reference

Vendor	Model	DSS	Lines	Exp
Yealink	T54W	10	16	2
Yealink	T46U	27	16	6
Yealink	T42S	6	12	0
Grandstream	GXP2170	48	12	4
Grandstream	GRP2612	8	4	0
Polycom	VVX450	30	12	3
Cisco	8851	10	10	2

---

7. Troubleshooting Tips

Common Issues

Symptom	Possible Cause	Solution
Can't delete model	Has templates/devices	Remove dependencies
Wrong key count	Incorrect DSS value	Update model specs
Auto-detect fails	Wrong MAC prefix	Correct OUI
Model not in dropdown	Not created	Add model first

Check Model Data

Sql

SELECT 
  m.model_name,
  v.name AS vendor,
  m.dss_keys,
  m.sip_lines,
  m.expansion_modules
FROM public.provisioning_device_models m
JOIN public.provisioning_vendors v ON v.id = m.vendor_id
ORDER BY v.name, m.model_name;

Check Device Count

Sql

SELECT 
  m.model_name,
  COUNT(d.id) AS device_count
FROM public.provisioning_device_models m
LEFT JOIN public.provisioning_devices d ON d.model_id = m.id
GROUP BY m.id, m.model_name
ORDER BY device_count DESC;

---

8. Glossary

Term	Definition
DSS Keys	Direct Station Selection keys
BLF	Busy Lamp Field
SIP Lines	SIP account capacity
Expansion Module	Attached key panel
OUI	Organizationally Unique Identifier (MAC prefix)
MAC Address	Hardware address

---

Lua Script Status ℹ️

Data Management Module

Component	Status
Device Models	ℹ️ Catalog data - no Lua handler required

Device Models is a data management module. It maintains the model catalog used by templates and devices. No Lua handlers are required.

---

Documentation last updated: January 2026

Device Models Module Documentation

Table of Contents

1. Module Overview (Technical)

What Are Device Models?

Architecture

Key Tables

Key Files

2. Module Overview (Commercial/Business)

Business Value

Use Cases

Feature Highlights

3. Module Overview (End User/Administrator)

What Can You Do?

Device Models Interface

Create/Edit Model

Quick Tips

4. Configuration Fields

Basic Information

Hardware Capabilities

Identification

5. Common Scenarios & Examples

Scenario 1: Browse Models

Scenario 2: Add New Model

Scenario 3: Update Capabilities

Scenario 4: Check Model Usage

6. Limitations & Important Notes

Technical Notes

Best Practices

Popular Models Reference

7. Troubleshooting Tips

Common Issues

Check Model Data

Check Device Count

8. Glossary

Lua Script Status ℹ️

Data Management Module