Merge pull request #29 from 0x524a/fix-go-onvif-references
fix: complete branding consistency - use onvif-go everywhere
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# Contributing to go-onvif
|
# Contributing to onvif-go
|
||||||
|
|
||||||
Thank you for your interest in contributing to go-onvif! 🎉
|
Thank you for your interest in contributing to onvif-go! 🎉
|
||||||
|
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|
||||||
@@ -97,7 +97,7 @@ Help us maintain compatibility information:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/0x524a/onvif-go.git
|
git clone https://github.com/0x524a/onvif-go.git
|
||||||
cd go-onvif
|
cd onvif-go
|
||||||
go build ./...
|
go build ./...
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -219,7 +219,7 @@ test: add integration tests for Hikvision cameras
|
|||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
go-onvif/
|
onvif-go/
|
||||||
├── client.go # Main ONVIF client
|
├── client.go # Main ONVIF client
|
||||||
├── types.go # ONVIF type definitions
|
├── types.go # ONVIF type definitions
|
||||||
├── device.go # Device service
|
├── device.go # Device service
|
||||||
@@ -272,4 +272,4 @@ By contributing, you agree that your contributions will be licensed under the MI
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Thank you for contributing to go-onvif! Your efforts help make ONVIF integration better for everyone. 🚀
|
Thank you for contributing to onvif-go! Your efforts help make ONVIF integration better for everyone. 🚀
|
||||||
|
|||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# Building and Releasing go-onvif
|
# Building and Releasing onvif-go
|
||||||
|
|
||||||
This document describes how to build binaries for multiple platforms and create releases.
|
This document describes how to build binaries for multiple platforms and create releases.
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -23,7 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Comprehensive test coverage for localhost URL handling (10 test cases)
|
- Comprehensive test coverage for localhost URL handling (10 test cases)
|
||||||
- New example: `examples/simplified-endpoint/` demonstrating all endpoint formats
|
- New example: `examples/simplified-endpoint/` demonstrating all endpoint formats
|
||||||
- Documentation: `docs/PROJECT_STRUCTURE.md` explaining project organization
|
- Documentation: `docs/PROJECT_STRUCTURE.md` explaining project organization
|
||||||
- Initial release of go-onvif library
|
- Initial release of onvif-go library
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- **Project Structure**: Implemented ideal Go project layout
|
- **Project Structure**: Implemented ideal Go project layout
|
||||||
|
|||||||
+4
-4
@@ -1,6 +1,6 @@
|
|||||||
# Contributing to go-onvif
|
# Contributing to onvif-go
|
||||||
|
|
||||||
First off, thank you for considering contributing to go-onvif! It's people like you that make go-onvif such a great tool.
|
First off, thank you for considering contributing to onvif-go! It's people like you that make onvif-go such a great tool.
|
||||||
|
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|
||||||
@@ -41,8 +41,8 @@ Enhancement suggestions are tracked as GitHub issues. When creating an enhanceme
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone your fork
|
# Clone your fork
|
||||||
git clone https://github.com/YOUR_USERNAME/go-onvif.git
|
git clone https://github.com/YOUR_USERNAME/onvif-go.git
|
||||||
cd go-onvif
|
cd onvif-go
|
||||||
|
|
||||||
# Add upstream remote
|
# Add upstream remote
|
||||||
git remote add upstream https://github.com/0x524a/onvif-go.git
|
git remote add upstream https://github.com/0x524a/onvif-go.git
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
# Quick Start Guide
|
# Quick Start Guide
|
||||||
|
|
||||||
Get up and running with go-onvif in 5 minutes!
|
Get up and running with onvif-go in 5 minutes!
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ A comprehensive diagnostic tool for collecting detailed information from ONVIF c
|
|||||||
|
|
||||||
### Option 1: Build from source
|
### Option 1: Build from source
|
||||||
```bash
|
```bash
|
||||||
cd /path/to/go-onvif
|
cd /path/to/onvif-go
|
||||||
go build -o onvif-diagnostics ./cmd/onvif-diagnostics/
|
go build -o onvif-diagnostics ./cmd/onvif-diagnostics/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ func main() {
|
|||||||
port := flag.Int("port", 8080, "Server port")
|
port := flag.Int("port", 8080, "Server port")
|
||||||
username := flag.String("username", "admin", "Authentication username")
|
username := flag.String("username", "admin", "Authentication username")
|
||||||
password := flag.String("password", "admin", "Authentication password")
|
password := flag.String("password", "admin", "Authentication password")
|
||||||
manufacturer := flag.String("manufacturer", "go-onvif", "Device manufacturer")
|
manufacturer := flag.String("manufacturer", "onvif-go", "Device manufacturer")
|
||||||
model := flag.String("model", "Virtual Multi-Lens Camera", "Device model")
|
model := flag.String("model", "Virtual Multi-Lens Camera", "Device model")
|
||||||
firmware := flag.String("firmware", "1.0.0", "Firmware version")
|
firmware := flag.String("firmware", "1.0.0", "Firmware version")
|
||||||
serial := flag.String("serial", "SN-12345678", "Serial number")
|
serial := flag.String("serial", "SN-12345678", "Serial number")
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# go-onvif Architecture & Design
|
# onvif-go Architecture & Design
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
go-onvif is a modern, performant Go library for communicating with ONVIF-compliant IP cameras and devices. It provides a clean, type-safe API with comprehensive support for device management, media streaming, PTZ control, and imaging settings.
|
onvif-go is a modern, performant Go library for communicating with ONVIF-compliant IP cameras and devices. It provides a clean, type-safe API with comprehensive support for device management, media streaming, PTZ control, and imaging settings.
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
@@ -351,7 +351,7 @@ Minimal external dependencies:
|
|||||||
|
|
||||||
## Conclusion
|
## Conclusion
|
||||||
|
|
||||||
go-onvif provides a modern, performant, and easy-to-use Go library for ONVIF camera integration. Its architecture prioritizes:
|
onvif-go provides a modern, performant, and easy-to-use Go library for ONVIF camera integration. Its architecture prioritizes:
|
||||||
- Developer experience (simple, intuitive API)
|
- Developer experience (simple, intuitive API)
|
||||||
- Type safety (compile-time error detection)
|
- Type safety (compile-time error detection)
|
||||||
- Performance (connection pooling, efficient operations)
|
- Performance (connection pooling, efficient operations)
|
||||||
|
|||||||
@@ -118,7 +118,7 @@ make build
|
|||||||
make docker
|
make docker
|
||||||
|
|
||||||
# Run container
|
# Run container
|
||||||
docker run -it go-onvif:latest
|
docker run -it onvif-go:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🎯 Key Improvements from Original
|
## 🎯 Key Improvements from Original
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Project Summary: go-onvif
|
# Project Summary: onvif-go
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
**go-onvif** is a complete refactoring and modernization of the ONVIF library, providing a comprehensive, performant, and developer-friendly Go library for communicating with ONVIF-compliant IP cameras and video devices.
|
**onvif-go** is a complete refactoring and modernization of the ONVIF library, providing a comprehensive, performant, and developer-friendly Go library for communicating with ONVIF-compliant IP cameras and video devices.
|
||||||
|
|
||||||
## What's Been Created
|
## What's Been Created
|
||||||
|
|
||||||
@@ -220,7 +220,7 @@ client.ContinuousMove(ctx, profiles[0].Token, velocity, nil)
|
|||||||
## Repository Structure
|
## Repository Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
go-onvif/
|
onvif-go/
|
||||||
├── README.md # Main documentation
|
├── README.md # Main documentation
|
||||||
├── QUICKSTART.md # Getting started guide
|
├── QUICKSTART.md # Getting started guide
|
||||||
├── ARCHITECTURE.md # Technical design doc
|
├── ARCHITECTURE.md # Technical design doc
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import (
|
|||||||
"github.com/0x524a/onvif-go/discovery"
|
"github.com/0x524a/onvif-go/discovery"
|
||||||
)
|
)
|
||||||
|
|
||||||
// This is a comprehensive demonstration of all go-onvif features
|
// This is a comprehensive demonstration of all onvif-go features
|
||||||
func main() {
|
func main() {
|
||||||
// Step 1: Discover cameras on the network
|
// Step 1: Discover cameras on the network
|
||||||
fmt.Println("=== Step 1: Discovering ONVIF Cameras ===")
|
fmt.Println("=== Step 1: Discovering ONVIF Cameras ===")
|
||||||
|
|||||||
@@ -73,7 +73,7 @@ func main() {
|
|||||||
|
|
||||||
if resp.StatusCode == 401 {
|
if resp.StatusCode == 401 {
|
||||||
fmt.Println("💡 Authentication required - this is expected!")
|
fmt.Println("💡 Authentication required - this is expected!")
|
||||||
fmt.Println("💡 Now testing with go-onvif client library...")
|
fmt.Println("💡 Now testing with onvif-go client library...")
|
||||||
fmt.Println()
|
fmt.Println()
|
||||||
testWithClient(username, password)
|
testWithClient(username, password)
|
||||||
} else {
|
} else {
|
||||||
@@ -91,7 +91,7 @@ func testWithClient(username, password string) {
|
|||||||
onvif := struct{}{}
|
onvif := struct{}{}
|
||||||
_ = onvif
|
_ = onvif
|
||||||
|
|
||||||
fmt.Println("Note: Would test with go-onvif client here, but keeping this simple.")
|
fmt.Println("Note: Would test with onvif-go client here, but keeping this simple.")
|
||||||
fmt.Println("The camera appears to be responding to ONVIF requests.")
|
fmt.Println("The camera appears to be responding to ONVIF requests.")
|
||||||
fmt.Println()
|
fmt.Println()
|
||||||
fmt.Println("💡 Next step: Check if the credentials are correct")
|
fmt.Println("💡 Next step: Check if the credentials are correct")
|
||||||
|
|||||||
+3
-3
@@ -42,7 +42,7 @@ A complete ONVIF-compliant server implementation that simulates multi-lens IP ca
|
|||||||
```bash
|
```bash
|
||||||
# Clone the repository (if not already done)
|
# Clone the repository (if not already done)
|
||||||
git clone https://github.com/0x524a/onvif-go
|
git clone https://github.com/0x524a/onvif-go
|
||||||
cd go-onvif
|
cd onvif-go
|
||||||
|
|
||||||
# Build the server CLI
|
# Build the server CLI
|
||||||
go build -o onvif-server ./cmd/onvif-server
|
go build -o onvif-server ./cmd/onvif-server
|
||||||
@@ -95,7 +95,7 @@ The server will start on `http://0.0.0.0:8080` with:
|
|||||||
-password string
|
-password string
|
||||||
Authentication password (default "admin")
|
Authentication password (default "admin")
|
||||||
-manufacturer string
|
-manufacturer string
|
||||||
Device manufacturer (default "go-onvif")
|
Device manufacturer (default "onvif-go")
|
||||||
-model string
|
-model string
|
||||||
Device model (default "Virtual Multi-Lens Camera")
|
Device model (default "Virtual Multi-Lens Camera")
|
||||||
-firmware string
|
-firmware string
|
||||||
@@ -430,7 +430,7 @@ This project is licensed under the MIT License - see the [LICENSE](../../LICENSE
|
|||||||
|
|
||||||
## Acknowledgments
|
## Acknowledgments
|
||||||
|
|
||||||
- Built on top of the [go-onvif](https://github.com/0x524a/onvif-go) client library
|
- Built on top of the [onvif-go](https://github.com/0x524a/onvif-go) client library
|
||||||
- ONVIF specifications from [ONVIF.org](https://www.onvif.org)
|
- ONVIF specifications from [ONVIF.org](https://www.onvif.org)
|
||||||
- Inspired by the need for flexible camera simulation in development workflows
|
- Inspired by the need for flexible camera simulation in development workflows
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -235,7 +235,7 @@ func DefaultConfig() *Config {
|
|||||||
BasePath: "/onvif",
|
BasePath: "/onvif",
|
||||||
Timeout: 30 * time.Second,
|
Timeout: 30 * time.Second,
|
||||||
DeviceInfo: DeviceInfo{
|
DeviceInfo: DeviceInfo{
|
||||||
Manufacturer: "go-onvif",
|
Manufacturer: "onvif-go",
|
||||||
Model: "Virtual Multi-Lens Camera",
|
Model: "Virtual Multi-Lens Camera",
|
||||||
FirmwareVersion: "1.0.0",
|
FirmwareVersion: "1.0.0",
|
||||||
SerialNumber: "SN-12345678",
|
SerialNumber: "SN-12345678",
|
||||||
|
|||||||
Reference in New Issue
Block a user